Sessions

Get a Session

Retrieve the information for 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

Response

Success

session_idstring required

Unique UUID

custom_idstring

Custom ID if Available

statusstring required

Current status of the session

readyboolean required

If the session is linked to a ready deployment

linkedboolean required

If the session is linked to a deployment

kindstring required

Type of session created

user_countinteger required

Count of user this session currently have

app_versioninteger required

App version linked to the session

create_timestring required

Session created at

elapsedinteger required

Elapsed time

errorstring

Error Detail

webhook_urlstring

When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url

Example response

{
  "session_id": "abc123-s",
  "custom_id": "custom-abc123",
  "status": "Ready",
  "ready": true,
  "linked": true,
  "kind": "Seat",
  "create_time": "2026-10-19 16:00:08.730124",
  "session_users": [
    {
      "ip": "1.2.3.4"
    }
  ],
  "session_ips": [
    {
      "ip": "1.2.3.4"
    }
  ],
  "deployment": {
    "request_id": "abc123",
    "public_ip": "100.10.0.85",
    "status": "Status.READY",
    "ready": true,
    "whitelisting_active": true,
    "fqdn": "abc123.test.edgegap.com",
    "ports": {
      "7777": {
        "external": 31669,
        "internal": 7777,
        "protocol": "UDP",
        "name": "7777",
        "tls_upgrade": false,
        "link": "example.com:31669",
        "proxy": 65002
      },
      "web": {
        "external": 31587,
        "internal": 8080,
        "protocol": "http",
        "name": "web",
        "tls_upgrade": true,
        "link": "https://example.com:31587",
        "proxy": 65001
      }
    },
    "location": {
      "city": "Montreal",
      "country": "Canada",
      "continent": "North America",
      "administrative_division": "Quebec",
      "timezone": "Eastern Time",
      "latitude": 45.508888,
      "longitude": -73.561668
    },
    "tags": [
      "production"
    ]
  },
  "webhook_url": "https://webhook.com"
}

Changes

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