Check list settings with provider

GET/account/api/v1/residential/lists/{id}/check

Authorization

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

Parameters

Name	Type	Description
`id` pathRequired	`integer`	An owned record ID for this operation; 1–2147483647. Not a display order number or supplier ID.

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/YOUR_LIST_ID/check'

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": {
        "tool": "ARN_RESIDENTIAL_LIST_CHECK_V1",
        "list_id": 30001,
        "read_only": true,
        "diagnostic": {
            "http_status": 200,
            "curl_errno": 0,
            "response_json": true,
            "provider_status": "success",
            "reason": "LIST_READ_VERIFIED",
            "api_version": "v2"
        },
        "elapsed_ms": 100,
        "read_timeout_seconds": 10,
        "data_shape": "array",
        "items_source": "data",
        "items_is_list": true,
        "items_count": 1,
        "matching_items": 1,
        "title_valid": true,
        "rotation_valid": true,
        "provider_get_attempts": 1,
        "provider_post_requests": 0,
        "database_changes": 0,
        "operation_journal_changes": 0,
        "raw_response_included": false,
        "customer_values_included": false,
        "secret_values_included": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "provider_read_diagnostic"
    }
}

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.tool`	`string`	Operation-specific tool value; preserve its demonstrated type and consult the behavior notes.
`data.list_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.read_only`	`boolean`	Operation-specific read only value; preserve its demonstrated type and consult the behavior notes.
`data.diagnostic`	`object`	Operation-specific diagnostic value; preserve its demonstrated type and consult the behavior notes.
`data.diagnostic.http_status`	`integer`	Operation-specific http status value; preserve its demonstrated type and consult the behavior notes.
`data.diagnostic.curl_errno`	`integer`	Operation-specific curl errno value; preserve its demonstrated type and consult the behavior notes.
`data.diagnostic.response_json`	`boolean`	Operation-specific response json value; preserve its demonstrated type and consult the behavior notes.
`data.diagnostic.provider_status`	`string`	Operation-specific provider status value; preserve its demonstrated type and consult the behavior notes.
`data.diagnostic.reason`	`string`	Fixed reason code or null, never raw provider error text.
`data.diagnostic.api_version`	`string`	Operation-specific api version value; preserve its demonstrated type and consult the behavior notes.
`data.elapsed_ms`	`integer`	Operation-specific elapsed ms value; preserve its demonstrated type and consult the behavior notes.
`data.read_timeout_seconds`	`integer`	Operation-specific read timeout seconds value; preserve its demonstrated type and consult the behavior notes.
`data.data_shape`	`string`	Operation-specific data shape value; preserve its demonstrated type and consult the behavior notes.
`data.items_source`	`string`	Operation-specific items source value; preserve its demonstrated type and consult the behavior notes.
`data.items_is_list`	`boolean`	Operation-specific items is list value; preserve its demonstrated type and consult the behavior notes.
`data.items_count`	`integer`	Operation-specific items count value; preserve its demonstrated type and consult the behavior notes.
`data.matching_items`	`integer`	Operation-specific matching items value; preserve its demonstrated type and consult the behavior notes.
`data.title_valid`	`boolean`	Operation-specific title valid value; preserve its demonstrated type and consult the behavior notes.
`data.rotation_valid`	`boolean`	Operation-specific rotation valid value; preserve its demonstrated type and consult the behavior notes.
`data.provider_get_attempts`	`integer`	Operation-specific provider get attempts value; preserve its demonstrated type and consult the behavior notes.
`data.provider_post_requests`	`integer`	Operation-specific provider post requests value; preserve its demonstrated type and consult the behavior notes.
`data.database_changes`	`integer`	Operation-specific database changes value; preserve its demonstrated type and consult the behavior notes.
`data.operation_journal_changes`	`integer`	Operation-specific operation journal changes value; preserve its demonstrated type and consult the behavior notes.
`data.raw_response_included`	`boolean`	Operation-specific raw response included value; preserve its demonstrated type and consult the behavior notes.
`data.customer_values_included`	`boolean`	Operation-specific customer values included value; preserve its demonstrated type and consult the behavior notes.
`data.secret_values_included`	`boolean`	Operation-specific secret values included 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.