Verify credential group and available actions

GET/account/api/v1/proxies/{id}/access

Authorization

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
Required permission	`proxy_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/proxies/YOUR_PROXY_ID/access'

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": {
        "proxy_id": 12345,
        "proxy_ids": [
            12345
        ],
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "verified_at": "2030-01-01T12:00:00+00:00",
        "username": null,
        "authorized_ips": [],
        "credential_rules": {
            "username_min_length": 8,
            "username_max_length": 8,
            "password_min_length": 10,
            "password_max_length": 10,
            "generated_username_length": 8,
            "generated_password_length": 10,
            "characters": "ASCII_ALPHANUMERIC"
        },
        "credential_role": "primary",
        "primary_credentials_managed_by": "admin",
        "credentials_change_available": false,
        "credentials_delete_available": false,
        "credentials_change_requires_new_username": false,
        "credential_management_unavailable_reason": "PRIMARY_CREDENTIAL_ADMIN_ONLY",
        "supplemental_credentials_available": false,
        "authorized_ip_add_available": true,
        "authorized_ip_remove_available": true,
        "authorized_ip_families": [
            4,
            6
        ],
        "ip_management_unavailable_reason": null,
        "group_change_required": true,
        "source": "provider_verified_scope",
        "authorization_scope": "upstream_order",
        "may_affect_other_proxies": false,
        "ip_records_customer_owned": true
    },
    "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.proxy_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.proxy_ids`	`array`	Proxy IDs in the scope visible to this account.
`data.proxy_ids[]`	`integer`	Proxy IDs in the scope visible to this account.
`data.revision`	`string`	Freshness fingerprint to copy unchanged to the corresponding write/price confirmation.
`data.verified_at`	`string`	Timestamp in the API’s returned representation; example dates are synthetic.
`data.username`	`string\|null`	Sensitive credentials subject to permission and valid service; never log or share.
`data.authorized_ips`	`string[]`	Operation-specific authorized ips value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules`	`object`	Operation-specific credential rules value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.username_min_length`	`integer`	Operation-specific username min length value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.username_max_length`	`integer`	Operation-specific username max length value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.password_min_length`	`integer`	Operation-specific password min length value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.password_max_length`	`integer`	Operation-specific password max length value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.generated_username_length`	`integer`	Operation-specific generated username length value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.generated_password_length`	`integer`	Operation-specific generated password length value; preserve its demonstrated type and consult the behavior notes.
`data.credential_rules.characters`	`string`	Operation-specific characters value; preserve its demonstrated type and consult the behavior notes.
`data.credential_role`	`string`	Operation-specific credential role 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.credentials_change_available`	`boolean`	Operation-specific credentials change available value; preserve its demonstrated type and consult the behavior notes.
`data.credentials_delete_available`	`boolean`	Operation-specific credentials delete available value; preserve its demonstrated type and consult the behavior notes.
`data.credentials_change_requires_new_username`	`boolean`	Operation-specific credentials change requires new username value; preserve its demonstrated type and consult the behavior notes.
`data.credential_management_unavailable_reason`	`string`	Operation-specific credential management unavailable reason value; preserve its demonstrated type and consult the behavior notes.
`data.supplemental_credentials_available`	`boolean`	Operation-specific supplemental credentials available value; preserve its demonstrated type and consult the behavior notes.
`data.authorized_ip_add_available`	`boolean`	Operation-specific authorized ip add available value; preserve its demonstrated type and consult the behavior notes.
`data.authorized_ip_remove_available`	`boolean`	Operation-specific authorized ip remove available 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.ip_management_unavailable_reason`	`string\|null`	Operation-specific ip management unavailable reason value; preserve its demonstrated type and consult the behavior notes.
`data.group_change_required`	`boolean`	Operation-specific group change required 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.authorization_scope`	`string`	Authorization scope. Order/package operations may affect other assignments.
`data.may_affect_other_proxies`	`boolean`	Other assignments may be affected by the package/order-wide scope.
`data.ip_records_customer_owned`	`boolean`	Operation-specific ip records customer owned 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

An action may apply to an entire authorization group, such as an order or package, rather than only the selected proxy. Review proxy_ids, authorization_scope and may_affect_other_proxies before continuing. Obtain a new revision if the scope changes.
The allowlist in My account → API controls which addresses may use the API key and is managed on the account page. Proxy authorized-IP operations control which addresses may connect to the proxy. These settings do not modify one another.