Permissions and available operations

GET/account/api/v1/capabilities

Authorization

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

Parameters

No additional parameters are required.

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/capabilities'

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": {
        "mode": "public_customer_access",
        "resources": [
            "extra_login_replace_options",
            "extra_login_replace",
            "extra_login_replace_status",
            "extra_login_replace_resume",
            "extra_login_options",
            "extra_login_create",
            "extra_login",
            "extra_login_delete",
            "extra_login_operation_status",
            "extra_login_resume",
            "extra_logins",
            "extra_login_history",
            "proxy_access",
            "proxy_credentials_change",
            "proxy_authorized_ip_add",
            "proxy_authorized_ip_remove",
            "proxy_access_operation_status",
            "proxy_access_operation_resume",
            "rotating_options",
            "rotating_rotation",
            "rotating_operation_status",
            "proxy_note",
            "proxy_note_update",
            "auto_renewal_settings",
            "auto_renewal_options",
            "auto_renewal_quote",
            "auto_renewal_enable",
            "auto_renewal_disable",
            "auto_renewal_operation_status",
            "capabilities",
            "account",
            "balance",
            "products",
            "catalog",
            "quote",
            "purchase",
            "purchase_status",
            "orders",
            "order",
            "order_delivery",
            "order_proxies",
            "proxies",
            "proxy",
            "proxy_export",
            "proxy_actions",
            "renewal_options",
            "renewal_quote",
            "renewal",
            "renewal_status",
            "replacement_quote",
            "replacement",
            "replacement_status",
            "replacement_requests",
            "residential_catalog",
            "residential_quote",
            "residential_purchase",
            "residential_purchase_status",
            "residential_session_options",
            "residential_session_create",
            "residential_session_export",
            "residential_isp_codes",
            "residential_locations",
            "residential_traffic",
            "residential_export",
            "residential_packages",
            "residential_package",
            "residential_lists",
            "residential_list",
            "residential_list_options",
            "residential_list_create",
            "residential_list_delete",
            "residential_list_action_status",
            "residential_list_check",
            "residential_package_refresh",
            "residential_list_rename",
            "residential_list_rotation",
            "residential_operation_status"
        ],
        "purchases": true,
        "renewals": true,
        "credential_access": true,
        "proxy_export": true,
        "replacement_quotes": true,
        "replacement_requests": true,
        "replacement_mode": "admin_review",
        "provider_management": true,
        "proxy_management": true,
        "residential": true,
        "residential_mode": "list_management",
        "residential_purchases": true,
        "residential_management": true,
        "residential_list_creation": true,
        "residential_list_deletion": true,
        "residential_package_refresh": true,
        "catalog": true,
        "price_quotes": true,
        "renewal_price_quotes": true,
        "version": "1.0",
        "source": "arnproxy_records",
        "order_delivery": true,
        "order_proxies": true,
        "documentation_url": "https://docs.arnproxy.com/api-v1/overview",
        "resource_methods": {
            "extra_login_replace_options": "GET",
            "extra_login_replace": "POST",
            "extra_login_replace_status": "GET",
            "extra_login_replace_resume": "POST",
            "extra_login_options": "GET",
            "extra_login_create": "POST",
            "extra_login": "GET",
            "extra_login_delete": "POST",
            "extra_login_operation_status": "GET",
            "extra_login_resume": "POST",
            "extra_logins": "GET",
            "extra_login_history": "GET",
            "proxy_access": "GET",
            "proxy_credentials_change": "POST",
            "proxy_authorized_ip_add": "POST",
            "proxy_authorized_ip_remove": "POST",
            "proxy_access_operation_status": "GET",
            "proxy_access_operation_resume": "POST",
            "rotating_options": "GET",
            "rotating_rotation": "POST",
            "rotating_operation_status": "GET",
            "proxy_note": "GET",
            "proxy_note_update": "POST",
            "auto_renewal_settings": "GET",
            "auto_renewal_options": "GET",
            "auto_renewal_quote": "POST",
            "auto_renewal_enable": "POST",
            "auto_renewal_disable": "POST",
            "auto_renewal_operation_status": "GET",
            "capabilities": "GET",
            "account": "GET",
            "balance": "GET",
            "products": "GET",
            "catalog": "GET",
            "quote": "POST",
            "purchase": "POST",
            "purchase_status": "GET",
            "orders": "GET",
            "order": "GET",
            "order_delivery": "GET",
            "order_proxies": "GET",
            "proxies": "GET",
            "proxy": "GET",
            "proxy_export": "POST",
            "proxy_actions": "GET",
            "renewal_options": "GET",
            "renewal_quote": "POST",
            "renewal": "POST",
            "renewal_status": "GET",
            "replacement_quote": "POST",
            "replacement": "POST",
            "replacement_status": "GET",
            "replacement_requests": "GET",
            "residential_catalog": "GET",
            "residential_quote": "POST",
            "residential_purchase": "POST",
            "residential_purchase_status": "GET",
            "residential_session_options": "GET",
            "residential_session_create": "POST",
            "residential_session_export": "POST",
            "residential_isp_codes": "GET",
            "residential_locations": "GET",
            "residential_traffic": "GET",
            "residential_export": "POST",
            "residential_packages": "GET",
            "residential_package": "GET",
            "residential_lists": "GET",
            "residential_list": "GET",
            "residential_list_options": "GET",
            "residential_list_create": "POST",
            "residential_list_delete": "POST",
            "residential_list_action_status": "GET",
            "residential_list_check": "GET",
            "residential_package_refresh": "POST",
            "residential_list_rename": "POST",
            "residential_list_rotation": "POST",
            "residential_operation_status": "GET"
        },
        "public_access_enabled": true,
        "primary_credentials_change": false,
        "primary_credentials_delete": false,
        "supplemental_credentials": true,
        "primary_credentials_managed_by": "admin",
        "supplemental_records": true,
        "supplemental_creation": true,
        "supplemental_provider_deletion": true,
        "rotating_management": true,
        "rotating_scope": "package",
        "rotating_shared_package_changes": true,
        "proxy_notes": true,
        "proxy_note_update": true,
        "automatic_renewal_configuration": true,
        "automatic_renewal_methods": [
            "balance"
        ],
        "api_key_revocation_stops_existing_renewals": false,
        "residential_session_list_creation": true,
        "residential_session_export": true,
        "residential_isp_codes": true,
        "extra_login_replacement": true,
        "residential_locations": true,
        "residential_traffic": true,
        "residential_export": true,
        "residential_session_targeting": true,
        "residential_package_deletion": false,
        "residential_list_create_authentication": [
            "login_password",
            "ip_auth"
        ],
        "residential_authorized_ip_families": [
            4
        ],
        "residential_existing_list_ip_edit": false,
        "residential_topups": true,
        "residential_purchase_status": true,
        "key_management": "per_customer_one_active_key",
        "access_requires_approval": false,
        "limits": {
            "requests_per_minute": 60,
            "used_this_minute": 1,
            "remaining_this_minute": 59,
            "resets_at": "2030-01-01T12:00:00+00:00",
            "key_changes_per_minute": 5,
            "new_purchases_per_hour": 10,
            "new_renewals_per_hour": 10,
            "new_replacements_per_hour": 10,
            "auto_renewal_changes_per_hour": 20
        },
        "permissions": {
            "account_allowed": {
                "credentials": true,
                "purchases": true,
                "renewals": true,
                "replacements": true,
                "residential_management": true,
                "proxy_management": true
            },
            "key_selected": {
                "credentials": true,
                "purchases": true,
                "renewals": true,
                "replacements": true,
                "residential_management": true,
                "proxy_management": true
            },
            "administrator_approval_required": false,
            "administrator_restrictions_apply": true,
            "customer_selection_required": false
        },
        "customer_permission_selection_required": false,
        "administrator_restrictions_apply": true,
        "key_provisioning": "automatic_on_first_api_page_visit",
        "endpoint_base": "https://www.arnproxy.com/account/api/v1/",
        "resource_paths": {
            "capabilities": "capabilities",
            "account": "account",
            "balance": "balance",
            "products": "products",
            "catalog": "catalog",
            "quote": "quote",
            "orders": "orders",
            "order": "orders/{id}",
            "order_delivery": "orders/{id}/delivery",
            "order_proxies": "orders/{id}/proxies",
            "purchase": "orders/create",
            "purchase_status": "orders/create/status",
            "proxies": "proxies",
            "proxy": "proxies/{id}",
            "proxy_actions": "proxies/{id}/actions",
            "proxy_export": "proxies/export",
            "proxy_access": "proxies/{id}/access",
            "proxy_note": "proxies/{id}/note",
            "proxy_note_update": "proxies/note",
            "proxy_credentials_change": "proxies/primary-credentials/change",
            "proxy_authorized_ip_add": "proxies/authorized-ips/add",
            "proxy_authorized_ip_remove": "proxies/authorized-ips/remove",
            "proxy_access_operation_status": "proxies/access/status",
            "proxy_access_operation_resume": "proxies/access/resume",
            "renewal_options": "renewals/options",
            "renewal_quote": "renewals/quote",
            "renewal": "renewals/create",
            "renewal_status": "renewals/status",
            "replacement_quote": "replacements/quote",
            "replacement": "replacements/create",
            "replacement_status": "replacements/status",
            "replacement_requests": "replacements",
            "extra_logins": "extra-logins",
            "extra_login": "extra-logins/{id}",
            "extra_login_history": "extra-logins/history",
            "extra_login_options": "extra-logins/options",
            "extra_login_create": "extra-logins/create",
            "extra_login_delete": "extra-logins/delete",
            "extra_login_operation_status": "extra-logins/status",
            "extra_login_resume": "extra-logins/resume",
            "extra_login_replace_options": "extra-logins/replace/options",
            "extra_login_replace": "extra-logins/replace",
            "extra_login_replace_status": "extra-logins/replace/status",
            "extra_login_replace_resume": "extra-logins/replace/resume",
            "rotating_options": "rotating/{id}/options",
            "rotating_rotation": "rotating/rotation",
            "rotating_operation_status": "rotating/status",
            "auto_renewal_settings": "auto-renewal",
            "auto_renewal_options": "auto-renewal/options",
            "auto_renewal_quote": "auto-renewal/quote",
            "auto_renewal_enable": "auto-renewal/enable",
            "auto_renewal_disable": "auto-renewal/disable",
            "auto_renewal_operation_status": "auto-renewal/status",
            "residential_packages": "residential/packages",
            "residential_package": "residential/packages/{id}",
            "residential_package_refresh": "residential/packages/refresh",
            "residential_catalog": "residential/catalog",
            "residential_quote": "residential/quote",
            "residential_purchase": "residential/orders/create",
            "residential_purchase_status": "residential/orders/status",
            "residential_locations": "residential/locations",
            "residential_traffic": "residential/traffic",
            "residential_export": "residential/export",
            "residential_isp_codes": "residential/isp-codes",
            "residential_lists": "residential/lists",
            "residential_list": "residential/lists/{id}",
            "residential_list_options": "residential/lists/options",
            "residential_list_create": "residential/lists/create",
            "residential_list_delete": "residential/lists/delete",
            "residential_list_action_status": "residential/lists/action-status",
            "residential_list_check": "residential/lists/{id}/check",
            "residential_list_rename": "residential/lists/rename",
            "residential_list_rotation": "residential/lists/rotation",
            "residential_operation_status": "residential/lists/status",
            "residential_session_options": "residential/sessions/options",
            "residential_session_create": "residential/sessions/create",
            "residential_session_export": "residential/sessions/export"
        }
    },
    "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.mode`	`string`	Operation-specific mode value; preserve its demonstrated type and consult the behavior notes.
`data.resources`	`array`	Defined resources and HTTP methods; listing does not grant execution permission.
`data.resources[]`	`string`	Defined resources and HTTP methods; listing does not grant execution permission.
`data.purchases`	`boolean`	Operation-specific purchases value; preserve its demonstrated type and consult the behavior notes.
`data.renewals`	`boolean`	Operation-specific renewals value; preserve its demonstrated type and consult the behavior notes.
`data.credential_access`	`boolean`	Whether this result/key includes or permits sensitive credentials.
`data.proxy_export`	`boolean`	Operation-specific proxy export value; preserve its demonstrated type and consult the behavior notes.
`data.replacement_quotes`	`boolean`	Operation-specific replacement quotes value; preserve its demonstrated type and consult the behavior notes.
`data.replacement_requests`	`boolean`	Operation-specific replacement requests value; preserve its demonstrated type and consult the behavior notes.
`data.replacement_mode`	`string`	Operation-specific replacement mode value; preserve its demonstrated type and consult the behavior notes.
`data.provider_management`	`boolean`	Operation-specific provider management value; preserve its demonstrated type and consult the behavior notes.
`data.proxy_management`	`boolean`	Operation-specific proxy management value; preserve its demonstrated type and consult the behavior notes.
`data.residential`	`boolean`	Operation-specific residential value; preserve its demonstrated type and consult the behavior notes.
`data.residential_mode`	`string`	Operation-specific residential mode value; preserve its demonstrated type and consult the behavior notes.
`data.residential_purchases`	`boolean`	Operation-specific residential purchases value; preserve its demonstrated type and consult the behavior notes.
`data.residential_management`	`boolean`	Operation-specific residential management value; preserve its demonstrated type and consult the behavior notes.
`data.residential_list_creation`	`boolean`	Operation-specific residential list creation value; preserve its demonstrated type and consult the behavior notes.
`data.residential_list_deletion`	`boolean`	Operation-specific residential list deletion value; preserve its demonstrated type and consult the behavior notes.
`data.residential_package_refresh`	`boolean`	Operation-specific residential package refresh value; preserve its demonstrated type and consult the behavior notes.
`data.catalog`	`boolean`	Operation-specific catalog value; preserve its demonstrated type and consult the behavior notes.
`data.price_quotes`	`boolean`	Operation-specific price quotes value; preserve its demonstrated type and consult the behavior notes.
`data.renewal_price_quotes`	`boolean`	Operation-specific renewal price quotes value; preserve its demonstrated type and consult the behavior notes.
`data.version`	`string`	Operation-specific version value; preserve its demonstrated type and consult the behavior notes.
`data.source`	`string`	Data source; local records and a live provider lookup are different evidence.
`data.order_delivery`	`boolean`	Operation-specific order delivery value; preserve its demonstrated type and consult the behavior notes.
`data.order_proxies`	`boolean`	Operation-specific order proxies value; preserve its demonstrated type and consult the behavior notes.
`data.documentation_url`	`string`	Operation-specific documentation url value; preserve its demonstrated type and consult the behavior notes.
`data.resource_methods`	`object`	Defined resources and HTTP methods; listing does not grant execution permission.
`data.resource_methods.*`	`string`	Operation name → GET or POST. Being listed does not grant permission.
`data.public_access_enabled`	`boolean`	Operation-specific public access enabled value; preserve its demonstrated type and consult the behavior notes.
`data.primary_credentials_change`	`boolean`	Operation-specific primary credentials change value; preserve its demonstrated type and consult the behavior notes.
`data.primary_credentials_delete`	`boolean`	Operation-specific primary credentials delete value; preserve its demonstrated type and consult the behavior notes.
`data.supplemental_credentials`	`boolean`	Operation-specific supplemental credentials value; preserve its demonstrated type and consult the behavior notes.
`data.primary_credentials_managed_by`	`string`	Operation-specific primary credentials managed by value; preserve its demonstrated type and consult the behavior notes.
`data.supplemental_records`	`boolean`	Operation-specific supplemental records value; preserve its demonstrated type and consult the behavior notes.
`data.supplemental_creation`	`boolean`	Operation-specific supplemental creation value; preserve its demonstrated type and consult the behavior notes.
`data.supplemental_provider_deletion`	`boolean`	Operation-specific supplemental provider deletion value; preserve its demonstrated type and consult the behavior notes.
`data.rotating_management`	`boolean`	Operation-specific rotating management value; preserve its demonstrated type and consult the behavior notes.
`data.rotating_scope`	`string`	Operation-specific rotating scope value; preserve its demonstrated type and consult the behavior notes.
`data.rotating_shared_package_changes`	`boolean`	Operation-specific rotating shared package changes value; preserve its demonstrated type and consult the behavior notes.
`data.proxy_notes`	`boolean`	Operation-specific proxy notes value; preserve its demonstrated type and consult the behavior notes.
`data.proxy_note_update`	`boolean`	Operation-specific proxy note update value; preserve its demonstrated type and consult the behavior notes.
`data.automatic_renewal_configuration`	`boolean`	Operation-specific automatic renewal configuration value; preserve its demonstrated type and consult the behavior notes.
`data.automatic_renewal_methods`	`array`	Operation-specific automatic renewal methods value; preserve its demonstrated type and consult the behavior notes.
`data.automatic_renewal_methods[]`	`string`	Operation-specific automatic renewal methods value; preserve its demonstrated type and consult the behavior notes.
`data.api_key_revocation_stops_existing_renewals`	`boolean`	false: revoking a key does not disable existing automatic renewal; disable the setting separately.
`data.residential_session_list_creation`	`boolean`	Operation-specific residential session list creation value; preserve its demonstrated type and consult the behavior notes.
`data.residential_session_export`	`boolean`	Operation-specific residential session export value; preserve its demonstrated type and consult the behavior notes.
`data.residential_isp_codes`	`boolean`	Operation-specific residential isp codes value; preserve its demonstrated type and consult the behavior notes.
`data.extra_login_replacement`	`boolean`	Operation-specific extra login replacement value; preserve its demonstrated type and consult the behavior notes.
`data.residential_locations`	`boolean`	Operation-specific residential locations value; preserve its demonstrated type and consult the behavior notes.
`data.residential_traffic`	`boolean`	Operation-specific residential traffic value; preserve its demonstrated type and consult the behavior notes.
`data.residential_export`	`boolean`	Operation-specific residential export value; preserve its demonstrated type and consult the behavior notes.
`data.residential_session_targeting`	`boolean`	Operation-specific residential session targeting value; preserve its demonstrated type and consult the behavior notes.
`data.residential_package_deletion`	`boolean`	Operation-specific residential package deletion value; preserve its demonstrated type and consult the behavior notes.
`data.residential_list_create_authentication`	`array`	Operation-specific residential list create authentication value; preserve its demonstrated type and consult the behavior notes.
`data.residential_list_create_authentication[]`	`string`	Operation-specific residential list create authentication value; preserve its demonstrated type and consult the behavior notes.
`data.residential_authorized_ip_families`	`array`	Operation-specific residential authorized ip families value; preserve its demonstrated type and consult the behavior notes.
`data.residential_authorized_ip_families[]`	`integer`	Operation-specific residential authorized ip families value; preserve its demonstrated type and consult the behavior notes.
`data.residential_existing_list_ip_edit`	`boolean`	Operation-specific residential existing list ip edit value; preserve its demonstrated type and consult the behavior notes.
`data.residential_topups`	`boolean`	Operation-specific residential topups value; preserve its demonstrated type and consult the behavior notes.
`data.residential_purchase_status`	`boolean`	Operation-specific residential purchase status value; preserve its demonstrated type and consult the behavior notes.
`data.key_management`	`string`	Operation-specific key management value; preserve its demonstrated type and consult the behavior notes.
`data.access_requires_approval`	`boolean`	Operation-specific access requires approval value; preserve its demonstrated type and consult the behavior notes.
`data.limits`	`object`	Account/operation limits; honor Retry-After on HTTP 429.
`data.limits.requests_per_minute`	`integer`	Current account minute limit, used requests or remaining requests in this window.
`data.limits.used_this_minute`	`integer`	Current account minute limit, used requests or remaining requests in this window.
`data.limits.remaining_this_minute`	`integer`	Current account minute limit, used requests or remaining requests in this window.
`data.limits.resets_at`	`string`	Operation-specific resets at value; preserve its demonstrated type and consult the behavior notes.
`data.limits.key_changes_per_minute`	`integer`	Operation-specific key changes per minute value; preserve its demonstrated type and consult the behavior notes.
`data.limits.new_purchases_per_hour`	`integer`	Operation-specific new purchases per hour value; preserve its demonstrated type and consult the behavior notes.
`data.limits.new_renewals_per_hour`	`integer`	Operation-specific new renewals per hour value; preserve its demonstrated type and consult the behavior notes.
`data.limits.new_replacements_per_hour`	`integer`	Operation-specific new replacements per hour value; preserve its demonstrated type and consult the behavior notes.
`data.limits.auto_renewal_changes_per_hour`	`integer`	Operation-specific auto renewal changes per hour value; preserve its demonstrated type and consult the behavior notes.
`data.permissions`	`object`	Permissions come from administrator account settings; customers do not select additional scopes. Existing administrator restrictions apply.
`data.permissions.account_allowed`	`object`	Operation-specific account allowed value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.account_allowed.credentials`	`boolean`	Sensitive credentials subject to permission and valid service; never log or share.
`data.permissions.account_allowed.purchases`	`boolean`	Operation-specific purchases value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.account_allowed.renewals`	`boolean`	Operation-specific renewals value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.account_allowed.replacements`	`boolean`	Operation-specific replacements value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.account_allowed.residential_management`	`boolean`	Operation-specific residential management value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.account_allowed.proxy_management`	`boolean`	Operation-specific proxy management value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.key_selected`	`object`	Permissions come from administrator account settings; customers do not select additional scopes. Existing administrator restrictions apply.
`data.permissions.key_selected.credentials`	`boolean`	Sensitive credentials subject to permission and valid service; never log or share.
`data.permissions.key_selected.purchases`	`boolean`	Operation-specific purchases value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.key_selected.renewals`	`boolean`	Operation-specific renewals value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.key_selected.replacements`	`boolean`	Operation-specific replacements value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.key_selected.residential_management`	`boolean`	Operation-specific residential management value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.key_selected.proxy_management`	`boolean`	Operation-specific proxy management value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.administrator_approval_required`	`boolean`	Operation-specific administrator approval required value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.administrator_restrictions_apply`	`boolean`	Operation-specific administrator restrictions apply value; preserve its demonstrated type and consult the behavior notes.
`data.permissions.customer_selection_required`	`boolean`	Operation-specific customer selection required value; preserve its demonstrated type and consult the behavior notes.
`data.customer_permission_selection_required`	`boolean`	Operation-specific customer permission selection required value; preserve its demonstrated type and consult the behavior notes.
`data.administrator_restrictions_apply`	`boolean`	Operation-specific administrator restrictions apply value; preserve its demonstrated type and consult the behavior notes.
`data.key_provisioning`	`string`	Operation-specific key provisioning value; preserve its demonstrated type and consult the behavior notes.
`data.endpoint_base`	`string`	Operation-specific endpoint base value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths`	`object`	Operation-specific resource paths value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.capabilities`	`string`	Operation-specific capabilities value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.account`	`string`	Operation-specific account value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.balance`	`string`	Operation-specific balance value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.products`	`string`	Operation-specific products value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.catalog`	`string`	Operation-specific catalog value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.quote`	`string`	Operation-specific quote value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.orders`	`string`	Operation-specific orders value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.order`	`string`	Operation-specific order value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.order_delivery`	`string`	Operation-specific order delivery value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.order_proxies`	`string`	Operation-specific order proxies value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.purchase`	`string`	Operation-specific purchase value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.purchase_status`	`string`	Operation-specific purchase status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxies`	`string`	Operation-specific proxies value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy`	`string`	Operation-specific proxy value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_actions`	`string`	Operation-specific proxy actions value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_export`	`string`	Operation-specific proxy export value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_access`	`string`	Operation-specific proxy access value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_note`	`string`	Operation-specific proxy note value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_note_update`	`string`	Operation-specific proxy note update value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_credentials_change`	`string`	Operation-specific proxy credentials change value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_authorized_ip_add`	`string`	Operation-specific proxy authorized ip add value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_authorized_ip_remove`	`string`	Operation-specific proxy authorized ip remove value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_access_operation_status`	`string`	Operation-specific proxy access operation status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.proxy_access_operation_resume`	`string`	Operation-specific proxy access operation resume value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.renewal_options`	`string`	Operation-specific renewal options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.renewal_quote`	`string`	Operation-specific renewal quote value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.renewal`	`string`	Operation-specific renewal value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.renewal_status`	`string`	Operation-specific renewal status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.replacement_quote`	`string`	Operation-specific replacement quote value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.replacement`	`string`	Operation-specific replacement value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.replacement_status`	`string`	Operation-specific replacement status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.replacement_requests`	`string`	Operation-specific replacement requests value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_logins`	`string`	Operation-specific extra logins value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login`	`string`	Operation-specific extra login value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_history`	`string`	Operation-specific extra login history value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_options`	`string`	Operation-specific extra login options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_create`	`string`	Operation-specific extra login create value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_delete`	`string`	Operation-specific extra login delete value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_operation_status`	`string`	Operation-specific extra login operation status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_resume`	`string`	Operation-specific extra login resume value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_replace_options`	`string`	Operation-specific extra login replace options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_replace`	`string`	Operation-specific extra login replace value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_replace_status`	`string`	Operation-specific extra login replace status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.extra_login_replace_resume`	`string`	Operation-specific extra login replace resume value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.rotating_options`	`string`	Operation-specific rotating options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.rotating_rotation`	`string`	Operation-specific rotating rotation value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.rotating_operation_status`	`string`	Operation-specific rotating operation status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.auto_renewal_settings`	`string`	Operation-specific auto renewal settings value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.auto_renewal_options`	`string`	Operation-specific auto renewal options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.auto_renewal_quote`	`string`	Operation-specific auto renewal quote value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.auto_renewal_enable`	`string`	Operation-specific auto renewal enable value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.auto_renewal_disable`	`string`	Operation-specific auto renewal disable value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.auto_renewal_operation_status`	`string`	Operation-specific auto renewal operation status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_packages`	`string`	Operation-specific residential packages value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_package`	`string`	Operation-specific residential package value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_package_refresh`	`string`	Operation-specific residential package refresh value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_catalog`	`string`	Operation-specific residential catalog value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_quote`	`string`	Operation-specific residential quote value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_purchase`	`string`	Operation-specific residential purchase value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_purchase_status`	`string`	Operation-specific residential purchase status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_locations`	`string`	Operation-specific residential locations value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_traffic`	`string`	Operation-specific residential traffic value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_export`	`string`	Operation-specific residential export value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_isp_codes`	`string`	Operation-specific residential isp codes value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_lists`	`string`	Operation-specific residential lists value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list`	`string`	Operation-specific residential list value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_options`	`string`	Operation-specific residential list options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_create`	`string`	Operation-specific residential list create value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_delete`	`string`	Operation-specific residential list delete value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_action_status`	`string`	Operation-specific residential list action status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_check`	`string`	Operation-specific residential list check value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_rename`	`string`	Operation-specific residential list rename value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_list_rotation`	`string`	Operation-specific residential list rotation value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_operation_status`	`string`	Operation-specific residential operation status value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_session_options`	`string`	Operation-specific residential session options value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_session_create`	`string`	Operation-specific residential session create value; preserve its demonstrated type and consult the behavior notes.
`data.resource_paths.residential_session_export`	`string`	Operation-specific residential session export 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 →