Справочник API

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

Обновить текущий workspace

Обновляет name и status workspace; оба поля обязательны. status принимает active или inactive, а inactive отключает аутентификацию всех API-ключей. Если metadata пропущено, текущее значение сохраняется; metadata={} очищает его, null недопустим.

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

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

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

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

Заголовки

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

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

Content-Type
stringобязательно

Используйте application/json при отправке JSON-тела запроса.

Тело запроса

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

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

minLength: 1

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

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

enum: active, inactive

metadata
object

Метаданные workspace. В PATCH пропустите поле для сохранения, передайте {} для очистки; null недопустим.

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

Следуйте описанию полей и HTTP-статуса. Успешный 204 не содержит тела; для диагностики используйте X-Request-Id. Следующий шаг указан в связанных операциях.

Ответ 200 OK

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

Тело ответа

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

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

400

Bad Request

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

401

Unauthorized

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

500

Internal Server Error

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

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

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

invalid_request · 10000 · 400
Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
invalid_api_key · 11001 · 401
Проверьте X-Api-Key и активность рабочего пространства.