API リファレンス

ワークスペース

現在の Workspace を更新

Workspace の name と status を更新します。両方とも必須です。status は active / inactive で、inactive では全 API キーが認証できません。metadata を省略すると現値を保持し、metadata={} でクリアします。null は指定できません。 is_beta は既定で無効な読み取り専用フラグです。利用申請はプラットフォームへ。PATCH や metadata では変更できません。

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

対応チャネル

all

呼び出す前に

対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。

リクエストパラメータ

ヘッダー

X-Api-Key
string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

Content-Type
string必須

JSON のリクエストボディを送る場合は application/json を使用します。

リクエストボディ

name
string必須

Workspace の表示名。

minLength: 1

status
string必須

Workspace の状態: active または inactive。inactive ではすべての API キーが認証できません。

enum: active, inactive

metadata
object

Workspace メタデータ。PATCH では省略で保持、{} でクリアします。null は無効です。

結果の確認

この API に記載された応答項目と HTTP 状態で結果を判断し、関連操作から次の手順を選びます。

レスポンス 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 ヘッダが欠落しているか無効です。

500

Internal Server Error

サービスで予期しないエラーが発生しました。

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。 エラーリファレンス

invalid_request · 10000 · 400
必須項目、形式、チャネルの条件を確認して修正します。
missing_api_key · 11000 · 401
X-Api-Key とワークスペースの有効性を確認します。
invalid_api_key · 11001 · 401
X-Api-Key とワークスペースの有効性を確認します。