Lists a collection of active sessions.

Lists all of the active sessions that are tied to your API token. Note that it only returns sessions that are active. Those that have already been stopped, will not be included.

get/session

Request

Base URL: https://api.sandbox-gameye.gameye.net
URL: https://api.sandbox-gameye.gameye.net/session
Auth: HTTP bearer

Query parameters

allboolean

Whether to return all sessions regardless of status in the response. The default value for this is 'false', which would only return running sessions.

locationstring

Filter results by location.

imagestring

Filter results by image.

tagstring

Filter results by tag.

hoststring

Filter results by host IP address.

playerCountobject

Filter results by player count. The following keys are available: - 'lt': Less than - 'gt': Greater than Combined with the 'location' filter above, this would for example allow users to search for specific sessions within a specific region and with less than X amount of players which is good to have for backfill purposes.

filterobject

A list or record of tags to filter a list of sessions on. If none of the sessions meet the provided filter criteria, naturally an empty list of sessions is returned.

Response

Successfully looked up all of the active sessions that are tied to your API token.

Example response

{
  "sessions": [
    {
      "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.