← Справочник API
ПровайдерыGET

Список регионов провайдера

Возвращает регионы, в которых развёрнут провайдер. supported показывает, работает ли провайдер в регионе вообще; allocatable показывает, можно ли в данный момент привязывать новые аккаунты к этому региону.

https://api.unifyport.ai/v1/providers/{provider}/regions

Заголовки

X-Api-Key
stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Параметры пути

provider
stringобязательно

Идентификатор для маршрута раздела providers.

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

Ответы

200
200 OK

Запрос выполнен. См. пример тела ответа.

400
Bad Request

Тело запроса, путь или параметры некорректны.

401
Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

409
Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500
Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

Запрос

curl -X GET https://api.unifyport.ai/v1/providers/{provider}/regions \
  -H "X-Api-Key: <YOUR_API_KEY>"

Ответ

{
  "data": {
    "provider": "telegram",
    "regions": [
      {
        "region": "global",
        "supported": true,
        "allocatable": true
      }
    ]
  }
}