Rotate a session proxy and record the reason.

post/sessions/{session_id}/rotate

Request

  • Base URL: https://api.nexalayer.net/v1
  • URL: https://api.nexalayer.net/v1/sessions/{session_id}/rotate
  • 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.

Headers

Idempotency-Keystring

Request body

reason'manual' | 'scheduled' | 'http_403' | 'http_429' | 'captcha' | 'timeout' | 'block'

Response

Rotated session. proxy.username, proxy.password, and proxy.full_url are omitted unless the include_credentials query parameter is true.

Changes

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