API REFERENCE

Перенаправления

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

Работает только с данными вашего аккаунта. Передавайте API-ключ в заголовке Authorization. Ответы возвращаются в JSON.

Запрос

В BASE_URL укажите HTTPS-адрес этого сайта, в API_KEY — свой секретный ключ. RESOURCE_ID замените идентификатором из ответа API.

cURL

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

Заголовки и параметры

Authorizationобязательно

Bearer YOUR_API_KEY

idpath · stringобязательно

Числовой ID домена; UUID для заказа, операции или запроса.

Ответ

202 означает «принято», а не «выполнено». Проверяйте состояние заказа или операции. При неизвестном результате не создавайте повторную покупку. Суммы — десятичные строки в USD, даты — ISO 8601.

request_idstringобязательно

Идентификатор для восстановления результата после сетевого сбоя.

itemsarrayобязательно

items[].idinteger

items[].slugstring

Имя перенаправления; используется для создания или обновления.

items[].targetstring

Целевой HTTP(S)-адрес перенаправления.

items[].enabledboolean

Включить или отключить выбранную функцию.

items[].status_codeinteger

HTTP-код: 301/308 — постоянный, 302/307 — временный. 307/308 сохраняют HTTP-метод.

items[].preserve_queryboolean

Сохранять параметры запроса в целевом адресе.

items[].source_patternstring

Шаблон исходного URL для перенаправления.

Пример структуры ответа · условные значения

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"
    }
  ]
}

Ошибки и статусы

error.code · error.message · request_id

401

Ключ неверен или отозван.

404

Ресурс не найден в вашем аккаунте.

409

Конфликт ключа повтора или запрос ещё выполняется.

422

Неверные параметры или условия операции, включая баланс.

500

Результат может быть неизвестен. Проверьте запрос.

503

Временно недоступно. Учитывайте Retry-After.