ARNPROXY

Export connection list

POST/account/api/v1/proxies/export

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread + optional credentials
Acceptapplication/json
Content-Typeapplication/json

Parameters

NameTypeDescription
proxy_ids
bodyRequired
integer[]1–1000 unique owned proxy IDs; do not mix product types where a common scope/price is required. Some operations have tighter bounds.
format
bodyOptional
stringendpoint | endpoint_credentials | credentials_endpoint. Credential-bearing formats need credentials permission. Also supports csv | custom.
Default: "endpoint"
columns
bodyConditional
string[]CSV only: id, endpoint, ip, port, login, password. Default ["id","endpoint"]. Login/password require credentials permission.
template
bodyConditional
stringRequired for custom, at most 200 characters. %endpoint%, %ip%, %port%, %id%, %login%, %username%, %password%, %login_url%, %password_url%. Control characters and unknown placeholders are rejected.

Request body

Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally.

request.json
{
    "proxy_ids": [
        "YOUR_PROXY_ID"
    ],
    "format": "endpoint"
}

Additional usage examples

IDs and prices are illustrative; use real values from the catalog and the same quote. JSON IDs and expected_total_minor must be numbers. Examples deliberately keep terms=false; submit terms=true only after explicit customer approval for the real paid operation.

CSV export

Choose CSV columns from id, endpoint, ip, port, login and password. Custom formats accept only the documented %...% tokens and never execute code. Credential-bearing output requires credentials permission. The content is returned inside JSON; your application saves it to a file.

application/json
{
    "proxy_ids": [
        10001
    ],
    "format": "csv",
    "columns": [
        "id",
        "endpoint"
    ]
}

Custom connection format

Choose CSV columns from id, endpoint, ip, port, login and password. Custom formats accept only the documented %...% tokens and never execute code. Credential-bearing output requires credentials permission. The content is returned inside JSON; your application saves it to a file.

application/json
{
    "proxy_ids": [
        10001
    ],
    "format": "custom",
    "template": "%login%:%password%@%endpoint%"
}

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 \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/proxies/export'

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": {
        "format": "endpoint",
        "count": 1,
        "content": "192.0.2.10:8080\r\n",
        "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.formatstringOperation-specific format value; preserve its demonstrated type and consult the behavior notes.
data.countintegerNumber of records visible in this result or generated connection strings.
data.contentstringOperation-specific content value; preserve its demonstrated type and consult the behavior notes.
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.

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

  • 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