Skip to content
Gameye Docs

Stop a session

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"
  }
}