Create a dynamic or static proxy session asynchronously.

post/sessions

Request

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

Headers

Idempotency-Keystring

Request body

session_type'dynamic' | 'static' required

product_nostring required

provisioning_mode'purchase' | 'existing'

Use existing for a resource already configured on the backend account; no NexaLayer purchase or charge is made.

resource_idstring

Optional existing static order number. If omitted, NexaLayer selects a usable static resource on the account.

quantitynumber

Greater than 0. Dynamic sessions use GB and may be fractional. Static sessions use IP count and must be an integer.

durationinteger

protocol'socks5' | 'http' | 'https'

country_codestring

city_codestring

project_idstring

Static shared proxy project code. Required by some shared static products.

rotation_mode'fixed' | 'timed' | 'on_demand'

rotation_interval_secinteger

Response

Session creation accepted. Poll GET /sessions/{session_id}. POST /sessions does not accept include_credentials; this response has no proxy credentials because the session is still being created.

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.