ARNPROXY

Extra login and its owned proxies

GET/account/api/v1/extra-logins/{id}

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionproxy_management + optional credentials
Acceptapplication/json

Parameters

NameTypeDescription
id
pathRequired
integerAn owned record ID for this operation; 1–2147483647. Not a display order number or supplier ID.
include_credentials
queryOptional
string"0" or "1"; default "0". "1" needs credentials permission and valid service.
Default: "0"

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

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": {
        "id": 40001,
        "state": "active",
        "proxies": [
            {
                "id": 12345,
                "endpoint": "192.0.2.10:8080"
            }
        ],
        "primary_credentials_modified": false,
        "credentials_included": 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.idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.statestringRecord/operation state. accepted is not delivery; completed is not a connection test.
data.proxiesarrayOperation-specific proxies value; preserve its demonstrated type and consult the behavior notes.
data.proxies[]objectOperation-specific proxies value; preserve its demonstrated type and consult the behavior notes.
data.proxies[].idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.proxies[].endpointstringProxy IP/host and optional port, without credentials; unverified formatting can produce null.
data.primary_credentials_modifiedbooleanOperation-specific primary credentials modified value; preserve its demonstrated type and consult the behavior notes.
data.credentials_includedbooleanWhether this result/key includes or permits sensitive credentials.
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.
data.usernameConditionalstringTop-level field, only with include_credentials=1, credentials permission and a verified active extra login.
data.passwordConditionalstringTop-level supplemental password under the same conditions.

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.
  • Credential-bearing output requires credentials permission. Never log or send returned connection strings, passwords or Authorization headers to support.

Search the current language. Close with Esc