---
title: "Get session status, proxy config, health, and usage."
method: GET
path: "/sessions/{session_id}"
---

# Get session status, proxy config, health, and usage.

`GET /sessions/{session_id}`

## Request

- Base URL: `https://api.nexalayer.net/v1`
- URL: `https://api.nexalayer.net/v1/sessions/{session_id}`
- Auth: API key in header `X-API-Key`

## Path parameters

- `session_id` string, required

## Query parameters

- `include_credentials` boolean

## Response `200`

Session detail. proxy.username, proxy.password, and proxy.full_url are omitted unless include_credentials=true.

- SessionResponse
  - `success` boolean
  - `data` object
    - `session_id` string
    - `session_type` string
    - `status` string
    - `provisioning_mode` 'purchase' | 'existing'
    - `proxy` object
      - `host` string
      - `port` integer
      - `username` string: Omitted unless the request set include_credentials=true. Present on GET session detail and rotate only when that query flag is true, and on renew responses for an active session.
      - `password` string: Omitted unless the request set include_credentials=true. Present on GET session detail and rotate only when that query flag is true, and on renew responses for an active session.
      - `protocol` string
      - `full_url` string, nullable: Omitted unless the request set include_credentials=true. Present on GET session detail and rotate only when that query flag is true, and on renew responses for an active session. Do not log this value.
    - `health` object
      - `risk_level` 'low' | 'medium' | 'high'
      - `health_score` integer
      - `success_rate` number
      - `consecutive_failures` integer

## Other responses

- `401`: API key is missing or invalid.
- `404`: The requested route (ROUTE_NOT_FOUND), product (PRODUCT_NOT_FOUND), or session (SESSION_NOT_FOUND) was not found. See https://docs.nexalayer.net/en/errors.

---

[API](https://skmtc.dev/nexalayer/apis/nexalayer-agent-api.md) · [All operations](https://skmtc.dev/nexalayer/apis/nexalayer-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nexalayer/apis/nexalayer-agent-api/revisions/126d0d474804?raw)