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_idstring required

Query parameters

include_credentialsboolean

Query parameter, default false. When true, an active session response includes proxy.username, proxy.password, and proxy.full_url. When omitted or false, those credential fields are omitted; host, port, and protocol are still returned. Accepted query values are true and false. The JSON body is not read for this flag. POST /sessions does not accept it.

Response

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

successboolean

Example response

{
  "data": {
    "proxy": {
      "full_url": "socks5://user:pass@proxy.example.com:1080"
    }
  }
}

Changes

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