Справочник API

Рабочая область

Получить текущий workspace

Возвращает workspace, связанный с заголовком X-Api-Key. ID workspace передавать в теле запроса не нужно. is_beta — флаг только для чтения, по умолчанию выключен. Обратитесь к платформе для доступа; PATCH и metadata не позволяют его включить.

GEThttps://api.unifyport.ai/v1/workspace

Поддерживаемые каналы

all

Перед вызовом

Используйте X-Api-Key нужного рабочего пространства на сервере. Перед запуском замените все заполнители.

Параметры запроса

Заголовки

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

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

Тело запроса

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

Как понять результат

Оцените результат по полям ответа и HTTP-статусу этого API, затем выберите следующий шаг в связанных операциях.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_used": 1,
    "account_quota_unlimited": false,
    "is_beta": false
  }
}

Тело ответа

is_beta
boolean

is_beta — флаг только для чтения, по умолчанию выключен. Обратитесь к платформе для доступа; PATCH и metadata не позволяют его включить.

name
string

Отображаемое имя workspace.

status
string

Статус workspace: active или inactive; при inactive все API-ключи не проходят аутентификацию.

enum: active, inactive

metadata
object

Ваши собственные метки окружения, сохранённые в workspace.

account_quota
integer

Текущая эффективная доступная только для чтения общая вместимость аккаунтов: включает бесплатную квоту и действующую платную квоту, не вычитая уже использованное количество; истекшая платная квота не учитывается.

format: uint64

account_quota_used
integer

Текущее использование квоты аккаунтов, только для чтения. Создание аккаунта сразу занимает квоту, удаление освобождает её. Аккаунты в ожидании авторизации, остановленные или отключённые также учитываются. После истечения платной квоты использование может превышать account_quota; возвращается фактическое использование.

format: uint64

account_quota_unlimited
boolean

Сохранённое для совместимости поле только для чтения; текущий режим квоты всегда возвращает false. Вместимость аккаунтов определяется по account_quota.

Ответы

200

200 OK

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

401

Unauthorized

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

500

Internal Server Error

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

При ошибке запроса

Проверьте HTTP и error.code/numeric_code, сохраните request_id. Исправьте параметры, завершите авторизацию или проверьте runtime. До повторной отправки или записи выясните результат предыдущей попытки. Справочник ошибок

missing_api_key · 11000 · 401
Проверьте X-Api-Key и активность рабочего пространства.
invalid_api_key · 11001 · 401
Проверьте X-Api-Key и активность рабочего пространства.