ARNPROXY

Available actions for one proxy

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

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread
Acceptapplication/json

Parameters

NameTypeDescription
id
pathRequired
integerAn 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/actions'

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,
        "export": true,
        "credentials_export": true,
        "replacement_quote": true,
        "replacement_request": true,
        "replacement_unavailable_reason": null,
        "replacement_requires_permission": false,
        "replacement_mode": "admin_review",
        "credential_change": false,
        "authorized_ip_change": false,
        "provider_package_management": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
data.proxy_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.exportbooleanOperation-specific export value; preserve its demonstrated type and consult the behavior notes.
data.credentials_exportbooleanOperation-specific credentials export value; preserve its demonstrated type and consult the behavior notes.
data.replacement_quotebooleanOperation-specific replacement quote value; preserve its demonstrated type and consult the behavior notes.
data.replacement_requestbooleanOperation-specific replacement request value; preserve its demonstrated type and consult the behavior notes.
data.replacement_unavailable_reasonstring|nullOperation-specific replacement unavailable reason value; preserve its demonstrated type and consult the behavior notes.
data.replacement_requires_permissionbooleanOperation-specific replacement requires permission value; preserve its demonstrated type and consult the behavior notes.
data.replacement_modestringOperation-specific replacement mode value; preserve its demonstrated type and consult the behavior notes.
data.credential_changebooleanOperation-specific credential change value; preserve its demonstrated type and consult the behavior notes.
data.authorized_ip_changebooleanOperation-specific authorized ip change value; preserve its demonstrated type and consult the behavior notes.
data.provider_package_managementbooleanOperation-specific provider package management value; preserve its demonstrated type and consult the behavior notes.
metaobjectRequest correlation and data-source metadata.
meta.request_idstringThis HTTP request’s correlation ID, not an operation key or order ID.
meta.phasestringOperation-specific phase value; preserve its demonstrated type and consult the behavior notes.
meta.sourcestringData 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

  • The legacy credential_change/authorized_ip_change=false summary does not disable newer supplemental-login/IP resources. Use capabilities and proxy_access/extra_login_options for those operations.

Search the current language. Close with Esc