API
API endpoints
Stop a session
1 min
forces a session to stop by killing the underlying container (we do this by sending a sigterm signal ) { "tab" "examples", "url" "https //api gameye io/session/{id}", "name" "stop session", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "children" \[], "description" "the id of the session " } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "m21l14tdcwuk8aeytqy5x", "code" "// the session has successfully been terminated ", "language" "200", "customlabel" "" }, { "id" "va3k8mccooln1ummiclph", "code" "// you are not authorized to stop a session please make sure that the \nincluded bearer token is correct ", "language" "401", "customlabel" "" }, { "id" "dfmuuktjulyeyqltznq 1", "code" "// the specified session does not exist please provide a correct session id ", "language" "404", "customlabel" "" }, { "id" "2dovlpni1 npvljed1xcv", "code" "// this session has already been terminated ", "language" "409", "customlabel" "" } ], "selectedlanguageid" "m21l14tdcwuk8aeytqy5x" }, "examples" { "languages" \[ { "id" "pggdvsx8scb8hworkfsel", "code" "curl location g request delete 'https //api gameye io/session/{id}' \\\\\n header 'accept application/json'", "language" "curl", "customlabel" "" }, { "id" "0796nok1xxsxvrspfmmsm", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\n\nvar requestoptions = {\n method 'delete',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api gameye io/session/{id}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "lw3usxqmzginjkrluqb3m", "code" "import requests\n\nurl = \\"https //api gameye io/session/{id}\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json'\n}\n\nresponse = requests request(\\"delete\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "language" "python", "customlabel" "" }, { "id" "ak2kxfq1cgvisbgoyonyj", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api gameye io/session/{id}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http delete new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" }, { "id" "rpglhbndjrwjipfztlqzu", "code" "var request = require('request');\nvar options = {\n 'method' 'delete',\n 'url' 'https //api gameye io/session/{id}',\n 'headers' {\n 'accept' 'application/json'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" } ], "selectedlanguageid" "ak2kxfq1cgvisbgoyonyj" }, "description" "", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } gameye doesn't stop any containers/sessions once it has been started, this endpoint must be called once a game server is no longer needed