Skip to main content
GET
/
app
/
sessions
/
{id}
Get
curl --request GET \
  --url https://api.ngrok.com/app/sessions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "id": "<string>",
  "uri": "<string>",
  "public_url": "<string>",
  "browser_session": {
    "user_agent": {
      "raw": "<string>",
      "browser_name": "<string>",
      "browser_version": "<string>",
      "device_type": "<string>",
      "os_name": "<string>",
      "os_version": "<string>"
    },
    "ip_address": "<string>",
    "location": {
      "country_code": "<string>",
      "latitude": 123,
      "longitude": 123,
      "lat_long_radius_km": 123
    }
  },
  "application_user": {
    "id": "<string>",
    "uri": "<string>"
  },
  "created_at": "<string>",
  "last_active": "<string>",
  "expires_at": "<string>",
  "endpoint": {
    "id": "<string>",
    "uri": "<string>"
  },
  "edge": {
    "id": "<string>",
    "uri": "<string>"
  },
  "route": {
    "id": "<string>",
    "uri": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Path Parameters

id
string
required

a resource identifier

Response

200 - application/json

Get an application session by ID.

id
string

unique application session resource identifier

uri
string

URI of the application session API resource

public_url
string

URL of the hostport served by this endpoint

browser_session
object

browser session details of the application session

application_user
object

application user this session is associated with

created_at
string

timestamp when the user was created in RFC 3339 format

last_active
string

timestamp when the user was last active in RFC 3339 format

expires_at
string

timestamp when session expires in RFC 3339 format

endpoint
object

ephemeral endpoint this session is associated with

edge
object

edge this session is associated with, null if the endpoint is agent-initiated

route
object

route this session is associated with, null if the endpoint is agent-initiated