Session-list scope and existing special lists

GET/account/api/v1/residential/sessions/options

Authorization

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
Required permission	`residential_management`
Accept	`application/json`

Parameters

Name	Type	Description
`package_id` queryRequired	`integer`	ARNPROXY package ID from residential_packages, never a supplier package_key.

Request example

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/residential/sessions/options?package_id=YOUR_PACKAGE_ID'

Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.

Responses

200Success response

application/json

{
    "ok": true,
    "data": {
        "package_id": 20001,
        "package_state": "active",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "creation_available": true,
        "lists": [
            {
                "id": 30002,
                "title": "Example session list",
                "package_state": "active"
            }
        ],
        "ttl_max_seconds": 86400,
        "session_max_length": 64,
        "target_fields": [
            "country",
            "subdivision",
            "city",
            "isp_id",
            "asn",
            "zip"
        ],
        "gb_purchase": false,
        "proxy_connection_tested": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

Response fields and types

Name	Type	Description
`ok`	`boolean`	Success envelope flag; on false inspect error.code.
`data`	`object`	Operation-specific result; examples are illustrative and synthetic.
`data.package_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.package_state`	`string`	Operation-specific package state value; preserve its demonstrated type and consult the behavior notes.
`data.revision`	`string`	Freshness fingerprint to copy unchanged to the corresponding write/price confirmation.
`data.creation_available`	`boolean`	Availability under the result’s conditions/permissions, not a stock or provider guarantee.
`data.lists`	`array`	Operation-specific lists value; preserve its demonstrated type and consult the behavior notes.
`data.lists[]`	`object`	Operation-specific lists value; preserve its demonstrated type and consult the behavior notes.
`data.lists[].id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.lists[].title`	`string`	Operation-specific title value; preserve its demonstrated type and consult the behavior notes.
`data.lists[].package_state`	`string`	Operation-specific package state value; preserve its demonstrated type and consult the behavior notes.
`data.ttl_max_seconds`	`integer`	Operation-specific ttl max seconds value; preserve its demonstrated type and consult the behavior notes.
`data.session_max_length`	`integer`	Operation-specific session max length value; preserve its demonstrated type and consult the behavior notes.
`data.target_fields`	`array`	Operation-specific target fields value; preserve its demonstrated type and consult the behavior notes.
`data.target_fields[]`	`string`	Operation-specific target fields value; preserve its demonstrated type and consult the behavior notes.
`data.gb_purchase`	`boolean`	Operation-specific gb purchase value; preserve its demonstrated type and consult the behavior notes.
`data.proxy_connection_tested`	`boolean`	Operation-specific proxy connection tested value; preserve its demonstrated type and consult the behavior notes.
`meta`	`object`	Request correlation and data-source metadata.
`meta.request_id`	`string`	This HTTP request’s correlation ID, not an operation key or order ID.
`meta.phase`	`string`	Operation-specific phase value; preserve its demonstrated type and consult the behavior notes.
`meta.source`	`string`	Data source; local records and a live provider lookup are different evidence.

Error response

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →

Behavior & important notes

Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed.
Session suffixes require a separately provisioned and verified special list. TTL requires a 1–64 letter/digit session. Positive s/m/h durations are limited to 24 hours. Formatting does not connect; actual use consumes traffic.