Describes a single session.

GET https://api.sandbox-gameye.gameye.net/session/{id}

Describe a single session by ID.

Code Examples

cURL

curl --location --globoff 'https://api.sandbox-gameye.gameye.net/session/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sandbox-gameye.gameye.net/session/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox-gameye.gameye.net/session/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

Python

import requests
import json

url = "https://api.sandbox-gameye.gameye.net/session/{id}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Responses

200

Successfully looked up the specified session.

Field	Type	Required
id	string	Yes
image	string	Yes
tag	string	Yes
location	string	Yes
host	string	Yes
created	number	Yes
port	map	Yes
status	string	Yes
labels	map	Yes
players	object	Yes

// Successfully looked up the specified session.

{
  "id": "f7965a22-e327-4541-a30e-8262890d3a29",
  "image": "nginx",
  "tag": "latest",
  "location": "europe",
  "host": "a.b.c.d",
  "created": 1648472895000,
  "port": "{\"port\":{\"80/tcp\":49160}}",
  "status": "",
  "labels": "{\"labels\":{\"env\":\"{\\\"GAMEYE_SESSION_ID\\\":\\\"c595bc6f-8522-4a62-95cd-8742136643ea\\\",\\\"GAMEYE_HOST\\\":\\\"a.b.c.d\\\"}\",\"tags\":\"{\\\"my-example-tag\\\":\\\"1\\\",\\\"another-example-tag\\\":\\\"3\\\"}\"}}",
  "players": {
    "joined": [
      ""
    ],
    "joinedCount": 0
  }
}

401

You are not authorized to describe sessions. Please make sure that the included bearer token is correct.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// You are not authorized to describe sessions. Please make sure that the included bearer token is correct.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}

404

The specified session does not exist. Please provide a correct session id.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// The specified session does not exist. Please provide a correct session id.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}