ARNPROXY

Active proxies belonging to one order

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

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread + 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.
after_id
queryOptional
integerUse next_after_id from the previous response; ascending-ID cursor, starting at 0.
Default: 0
limit
queryOptional
integer1–100; default 25.
Default: 25
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/orders/YOUR_ORDER_ID/proxies'

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": 12345,
                "endpoint": "192.0.2.10:8080",
                "last_service_date": "2030-02-01 00:00:00",
                "timezone": "Europe/Istanbul"
            }
        ],
        "next_after_id": null,
        "order_id": 10001,
        "source": "arnproxy_records"
    },
    "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[].endpointstringProxy IP/host and optional port, without credentials; unverified formatting can produce null.
data.items[].last_service_datestringLast service day: current, previous or projected by the quote. A projection does not renew.
data.items[].timezonestringTimezone for related date fields; null means no verified timezone.
data.next_after_idinteger|nullCursor for the next page; null means no further page in this result.
data.order_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.sourcestringData source; local records and a live provider lookup are different evidence.
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.items[].credentialsConditionalobjectOnly with include_credentials=1 and credentials permission.
data.items[].credentials.usernameConditionalstringPrimary delivery username.
data.items[].credentials.passwordConditionalstringPrimary delivery password; keep private.

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

  • id is the ARNPROXY order record ID, not its displayed number. Delivery lookup does not start live provider checks or redelivery.
  • 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