Describes a single session.

Describe a single session by ID.

get/session/{id}

Request

  • Base URL: https://api.sandbox-gameye.gameye.net
  • URL: https://api.sandbox-gameye.gameye.net/session/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The id of the session.

Response

Successfully looked up the specified session.

idstring required

The unique identifier of the session.

imagestring required

The name of the image of the game that is hosted inside the container.

tagstring required

The build tag of the image the container is derived from.

locationstring required

The location or region that the game session is hosted in.

hoststring required

The IP address of the host machine the game session is hosted on.

creatednumber required

The unix timestamp the session was created in.

portobject required

A record of exposed ports for this container.

status'created' | 'running' | 'restarting' | 'exited' | 'dead' | 'draining' | 'shuttingdown' | 'server_unreachable' required

The current runtime status of the underlying container.

labelsobject required

The collection of user-defined key/value metadata stored inside the configuration of the session.

Example response

{
  "id": "f7965a22-e327-4541-a30e-8262890d3a29",
  "image": "nginx",
  "tag": "latest",
  "location": "europe",
  "host": "a.b.c.d",
  "created": 1648472895000,
  "port": {
    "port": {
      "80/tcp": 49160
    }
  },
  "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\"}"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.