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

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

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

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

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

all

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

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

Запрос

curl -X PATCH "https://api.unifyport.ai/v1/workspace" \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Production Workspace",
  "status": "active",
  "metadata": {
    "region": "global",
    "env": "production"
  }
}'

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

Заголовки

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-статусу этого API, затем выберите следующий шаг в связанных операциях.

Ответ 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,
    "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

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

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

Запрос распознан, но операция запрещена.

404

Not Found

Запрошенный ресурс не найден. Сверьте error.code с текущей операцией.

500

Internal Server Error

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

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

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

Сопоставляйте HTTP-статус, error.code и error.numeric_code с текущей операцией. Числовой код — строка. Сохраняйте request_id для диагностики: это не ключ идемпотентности и не идентификатор задачи.

invalid_request · 10000 · 400

Проверьте JSON и обязательные поля.

Действия и повторы: Исправьте параметры с учётом операции и канала. Повтор неизменённого неверного запроса не устранит ошибку.

Пример JSON; message зависит от фактической причины · 400 · 10000

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Invalid request parameters"
  }
}

invalid_target_workspace · 11003 · 400

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

Условие: Применяется к запросам с заголовком переопределения рабочего пространства X-Workspace-Id.

Пример JSON; message зависит от фактической причины · 400 · 11003

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_target_workspace",
    "numeric_code": "11003",
    "message": "Invalid target workspace"
  }
}

update_workspace_failed · 41001 · 400

Операция отклонена. Проверьте запрос и сохраните request_id.

Действия и повторы: Перед повторным изменением прочитайте текущее состояние ресурса и выясните результат предыдущей попытки. Сохраните request_id; не повторяйте запись автоматически при неизвестном результате.

Пример JSON; message зависит от фактической причины · 400 · 41001

{
  "request_id": "req_example",
  "error": {
    "code": "update_workspace_failed",
    "numeric_code": "41001",
    "message": "Failed to update workspace"
  }
}

invalid_api_key · 11001 · 401

Проверьте правильность и активность ключа API.

Действия и повторы: Сохраните request_id и структурированные коды; выясните причину текущего сбоя перед следующим действием.

Пример JSON; message зависит от фактической причины · 401 · 11001

{
  "request_id": "req_example",
  "error": {
    "code": "invalid_api_key",
    "numeric_code": "11001",
    "message": "Invalid API key"
  }
}

missing_api_key · 11000 · 401

Добавьте заголовок X-Api-Key.

Пример · 401 · 11000

{
  "request_id": "req_xxx",
  "error": {
    "code": "missing_api_key",
    "numeric_code": "11000",
    "message": "Missing X-Api-Key header"
  }
}

workspace_override_forbidden · 11002 · 403

Запрос пытается переопределить рабочее пространство без необходимых прав. Удалите заголовок переопределения и используйте API-ключ нужного рабочего пространства.

Условие: Применяется к запросам с заголовком переопределения рабочего пространства X-Workspace-Id.

Пример JSON; message зависит от фактической причины · 403 · 11002

{
  "request_id": "req_example",
  "error": {
    "code": "workspace_override_forbidden",
    "numeric_code": "11002",
    "message": "Workspace override is not allowed"
  }
}

target_workspace_not_found · 11004 · 404

Переопределённое рабочее пространство не найдено или недоступно. Проверьте его принадлежность, удалите заголовок переопределения и используйте нужный API-ключ; повторы не дадут доступ.

Условие: Применяется к запросам с заголовком переопределения рабочего пространства X-Workspace-Id.

Действия и повторы: Проверьте идентификатор, принадлежность ресурса и текущее рабочее пространство. Не повторяйте запрос автоматически, считая подтверждённое отсутствие или недоступность временным сбоем сервиса.

Пример JSON; message зависит от фактической причины · 404 · 11004

{
  "request_id": "req_example",
  "error": {
    "code": "target_workspace_not_found",
    "numeric_code": "11004",
    "message": "Target workspace not found"
  }
}