本文へ
ドキュメントAPI リファレンスサーバー一覧を取得
GETBearer トークン

サーバー一覧を取得

/api/v1/servers

組織のサーバー、リージョン、プラン、状態、自動更新設定、有効期限を取得します。認証情報は含まれません。

API のフィールド名、型、コードはすべての言語で共通です。

リクエスト例

cURL
curl "https://tovahub.com/api/v1/servers" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

表示のみ。このページから API リクエストは送信されません。

レスポンス例
JSON
{
  "servers": [],
  "dashboard": "https://tovahub.com/dashboard/servers"
}

パラメーター

パラメーターなし。

レスポンス

HTTP ステータス 200

現在削除されていない組織のサーバーを、ログイン認証情報を含めずに一覧で取得します。

serversarray

現在のサーバーの概要。

servers[].idstring (ObjectId)

プラットフォーム側のサーバー識別子。

servers[].hostnamestring | null

保存されたホスト名。

servers[].planstring

プラン識別子。このレスポンスでは planId ではなく plan を使用します。

servers[].regionstring

リージョンコード。

servers[].statusstring

正規化された保存済みサーバー状態。

servers[].autoRenewboolean

保存されたサイト側の自動更新設定。

servers[].expiresAtstring (ISO 8601) | null

保存された支払い済み利用期限。

servers[].testOnlyboolean

隔離されたテスト用リソースかどうか。

servers[].testUntilstring (ISO 8601) | null

存在する場合、テストの有効期限。

servers[].updatedAtstring (ISO 8601)

サーバーレコードの最終更新日時。

servers[].statusCheckedAtstring (ISO 8601) | null

最後に状態を観測したタイムスタンプ。

dashboardstring (URL)

ダッシュボードのサーバー一覧 URL。