---
title: "Describes a single session."
method: GET
path: "/session/{id}"
---

# Describes a single session.

`GET /session/{id}`

## Request

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

Describe a single session by ID.

## Path parameters

- `id` string, required

## Response `200`

Successfully looked up the specified session.

- DescribedSession
  - `id` string, required: The unique identifier of the session.
  - `image` string, required: The name of the image of the game that is hosted inside the container.
  - `tag` string, required: The build tag of the image the container is derived from.
  - `location` string, required: The location or region that the game session is hosted in.
  - `host` string, required: The IP address of the host machine the game session is hosted on.
  - `created` number, required: The unix timestamp the session was created in.
  - `port` object, 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.
  - `labels` object, required: The collection of user-defined key/value metadata stored inside the configuration of the session.
  - `players` DescribedSessionPlayers, required
    - `joined` string[], required
    - `joinedCount` integer, required

## Other responses

- `401`: You are not authorized to describe sessions. Please make sure that the included bearer token is correct.
- `403`: Your API token may not have the required permissions to invoke this endpoint.
- `404`: The specified session does not exist. Please provide a correct session id.

---

[API](https://skmtc.dev/gameye/apis/gameye-session-api-2.md) · [All operations](https://skmtc.dev/gameye/apis/gameye-session-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/gameye/apis/gameye-session-api-2/revisions/0a019bf29067?raw)