---
title: "Get a Session"
method: GET
path: "/v1/session/{session_id}"
tags: ["Sessions"]
---

# Get a Session

`GET /v1/session/{session_id}`

## Request

- Base URL: `https://api.edgegap.com`
- URL: `https://api.edgegap.com/v1/session/{session_id}`
- Auth: API key in header `authorization`

Retrieve the information for a session.

## Response `200`

Success

- SessionGet
  - `session_id` string, required: Unique UUID
  - `custom_id` string: Custom ID if Available
  - `status` string, required: Current status of the session
  - `ready` boolean, required: If the session is linked to a ready deployment
  - `linked` boolean, required: If the session is linked to a deployment
  - `kind` string, required: Type of session created
  - `user_count` integer, required: Count of user this session currently have
  - `app_version` integer, required: App version linked to the session
  - `create_time` string, required: Session created at
  - `elapsed` integer, required: Elapsed time
  - `error` string: Error Detail
  - `session_users` SessionUser[]: Users in the session
    - `ip` string, required: Ip of the user connected to the Session
    - `latitude` number: Latitude
    - `longitude` number: Longitude
  - `session_ips` SessionUser[]: IPS in the session
    - `ip` string, required: Ip of the user connected to the Session
    - `latitude` number: Latitude
    - `longitude` number: Longitude
  - `deployment` Deployment
    - `request_id` string, required: Unique UUID
    - `public_ip` string, required: The public IP
    - `status` string, required: Current status of Deployment
    - `ready` boolean, required: if the deployment is ready
    - `whitelisting_active` boolean, required: if the deployment ACL is active
    - `fqdn` string, required
    - `ports` object
    - `location` DeploymentLocation
      - `city` string, required: City of the deployment
      - `country` string, required: Country of the deployment
      - `continent` string, required: Continent of the deployment
      - `administrative_division` string, required: Administrative division of the deployment
      - `timezone` string, required: Timezone of the deployment
      - `latitude` number, required: Latitude of the deployment
      - `longitude` number, required: Longitude of the deployment
    - `tags` string[]: List of tags associated with the deployment
    - `sockets` integer: The Capacity of the Deployment
    - `sockets_usage` integer: The Capacity Usage of the Deployment
    - `is_joinable_by_session` boolean: If the deployment is joinable by sessions
  - `webhook_url` string: When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/edgegap/apis/edgegap-v1.md) · [All operations](https://skmtc.dev/edgegap/apis/edgegap-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/edgegap/apis/edgegap-v1/revisions/9fa2b393a6be?raw)