ワークスペースGET

現在の Workspace を取得

X-Api-Key リクエストヘッダに紐づく Workspace を返します。リクエストボディに workspace_id を入れる必要はありません。

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
  }
}