API REFERENCE

List redirects

GET/api/v1/domains/{id}/redirects

Operates on your account only. Send your API key in the Authorization header. Responses use JSON.

Request

Set BASE_URL to this website’s HTTPS origin and API_KEY to your private key. Replace RESOURCE_ID with the ID returned by the API.

cURL

curl --request GET "${BASE_URL}/api/v1/domains/RESOURCE_ID/redirects" \
  --header "Authorization: Bearer $API_KEY"

Headers & parameters

Authorizationrequired

Bearer YOUR_API_KEY

idpath · stringrequired

Numeric domain ID; UUID for an order, operation or request.

Response

202 means accepted, not completed. Poll the order or operation. If the outcome is unknown, do not issue another purchase. Amounts are decimal strings in USD; dates use ISO 8601.

request_idstringrequired

Identifier used to recover an outcome after a network failure.

itemsarrayrequired

items[].idinteger

items[].slugstring

Redirect identifier used to create or update it.

items[].targetstring

Destination HTTP(S) URL.

items[].enabledboolean

Enable or disable the selected feature.

items[].status_codeinteger

HTTP status: 301/308 permanent, 302/307 temporary. 307/308 preserve the HTTP method.

items[].preserve_queryboolean

Preserve query parameters in the destination URL.

items[].source_patternstring

Source URL pattern for the redirect.

Response structure example · illustrative values

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "items": [
    {
      "id": 1,
      "slug": "string",
      "target": "string",
      "enabled": false,
      "status_code": 1,
      "preserve_query": false,
      "source_pattern": "string"
    }
  ]
}

Errors & statuses

error.code · error.message · request_id

401

Invalid or revoked key.

404

Resource not found in your account.

409

Idempotency conflict or request in progress.

422

Invalid parameters or business rule, including balance.

500

Outcome may be uncertain. Poll the request.

503

Temporarily unavailable. Respect Retry-After.