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

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

Возвращает workspace, связанный с заголовком X-Api-Key. ID workspace передавать в теле запроса не нужно.

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

Заголовки

X-Api-Key

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

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

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

У этого эндпоинта нет параметров пути.

Тело запроса

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

Тело ответа

name

string

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

status

string

Состояние жизненного цикла workspace, например active.

metadata

object

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

account_quota

number

Максимальное число аккаунтов провайдеров, допустимое в этом workspace.

account_quota_unlimited

boolean

Когда true, квота аккаунтов не ограничена, а account_quota игнорируется.

Ответы

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/workspace \
  -H "X-Api-Key: <YOUR_API_KEY>"

Ответ

{
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_unlimited": false
  }
}