ARNPROXY

Customer API supplemental registry

GET/account/api/v1/extra-logins

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionproxy_management
Acceptapplication/json

Parameters

NameTypeDescription
after_id
queryOptional
integerUse next_after_id from the previous response; ascending-ID cursor, starting at 0.
Default: 0
limit
queryOptional
integer1–50; default 25.
Default: 25

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/extra-logins'

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": {
        "items": [
            {
                "id": 40001,
                "reference": "00000000000000000000000000000000",
                "state": "active",
                "proxy_count": 1,
                "verified_at": "2030-01-01T12:00:00+00:00",
                "created_at": "2030-01-01T12:00:00+00:00",
                "cleanup_state": null,
                "cleanup_reason": null,
                "credentials_available": true
            }
        ],
        "next_after_id": null,
        "source": "supplemental_registry",
        "primary_credentials_included": false,
        "creation_enabled": true,
        "provider_deletion_enabled": true
    },
    "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.itemsarrayRecords on this page or formatted connection strings; an empty list can be valid.
data.items[]objectRecords on this page or formatted connection strings; an empty list can be valid.
data.items[].idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.items[].referencestringOperation-specific reference value; preserve its demonstrated type and consult the behavior notes.
data.items[].statestringRecord/operation state. accepted is not delivery; completed is not a connection test.
data.items[].proxy_countintegerNumber of records visible in this result or generated connection strings.
data.items[].verified_atstringTimestamp in the API’s returned representation; example dates are synthetic.
data.items[].created_atstringTimestamp in the API’s returned representation; example dates are synthetic.
data.items[].cleanup_statestring|nullState or fixed reason of the supplemental login’s independent expiry/cleanup record.
data.items[].cleanup_reasonstring|nullState or fixed reason of the supplemental login’s independent expiry/cleanup record.
data.items[].credentials_availablebooleanOperation-specific credentials available value; preserve its demonstrated type and consult the behavior notes.
data.next_after_idinteger|nullCursor for the next page; null means no further page in this result.
data.sourcestringData source; local records and a live provider lookup are different evidence.
data.primary_credentials_includedbooleanOperation-specific primary credentials included value; preserve its demonstrated type and consult the behavior notes.
data.creation_enabledbooleanOperation-specific creation enabled value; preserve its demonstrated type and consult the behavior notes.
data.provider_deletion_enabledbooleanOperation-specific provider deletion enabled 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

  • Extra logins are separate from the primary delivery login. Creating one does not replace the primary login or delete other extra logins. Read custom_credentials_available, username_length and password_length from the options response before creating credentials.
  • 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.

Search the current language. Close with Esc