List create/delete scope and revision

GET/account/api/v1/residential/lists/options

Authorization

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

Parameters

Name	Type	Description
`package_id` queryConditional	`integer`	Supply exactly one of package_id or list_id, never both.
`list_id` queryConditional	`integer`	Supply exactly one of package_id or list_id, never both.

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/lists/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,
        "list_id": null,
        "title": null,
        "package_state": "active",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "creation_available": true,
        "deletion_available": false,
        "create_authentication": "login_password",
        "create_authentication_methods": [
            "login_password",
            "ip_auth"
        ],
        "authorized_ip_families": [
            4
        ],
        "authorized_ip_max": 20,
        "authorized_ips": null,
        "existing_list_ip_edit": false,
        "port_count_min": 1,
        "port_count_max": 1000,
        "rotation_min": -1,
        "rotation_max": 3600,
        "gb_purchase": false,
        "package_deletion": 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.list_id`	`integer\|null`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.title`	`string\|null`	Operation-specific title value; preserve its demonstrated type and consult the behavior notes.
`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.deletion_available`	`boolean`	Availability under the result’s conditions/permissions, not a stock or provider guarantee.
`data.create_authentication`	`string`	Operation-specific create authentication value; preserve its demonstrated type and consult the behavior notes.
`data.create_authentication_methods`	`array`	Operation-specific create authentication methods value; preserve its demonstrated type and consult the behavior notes.
`data.create_authentication_methods[]`	`string`	Operation-specific create authentication methods value; preserve its demonstrated type and consult the behavior notes.
`data.authorized_ip_families`	`array`	Operation-specific authorized ip families value; preserve its demonstrated type and consult the behavior notes.
`data.authorized_ip_families[]`	`integer`	Operation-specific authorized ip families value; preserve its demonstrated type and consult the behavior notes.
`data.authorized_ip_max`	`integer`	Operation-specific authorized ip max value; preserve its demonstrated type and consult the behavior notes.
`data.authorized_ips`	`string[]\|null`	Operation-specific authorized ips value; preserve its demonstrated type and consult the behavior notes.
`data.existing_list_ip_edit`	`boolean`	Operation-specific existing list ip edit value; preserve its demonstrated type and consult the behavior notes.
`data.port_count_min`	`integer`	Operation-specific port count min value; preserve its demonstrated type and consult the behavior notes.
`data.port_count_max`	`integer`	Operation-specific port count max value; preserve its demonstrated type and consult the behavior notes.
`data.rotation_min`	`integer`	Operation-specific rotation min value; preserve its demonstrated type and consult the behavior notes.
`data.rotation_max`	`integer`	Operation-specific rotation max 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.package_deletion`	`boolean`	Operation-specific package deletion 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.
New lists support login_password or ip_auth. IP-auth lists accept 1–20 unique public IPv4 addresses. Deleting a list does not delete its GB package; only connections using that list are revoked.