本文へ
ドキュメントAPI リファレンスファイアウォール一覧を取得
GETBearer トークン

ファイアウォール一覧を取得

/api/v1/firewalls

組織とシステムのファイアウォール、ルール、適用先サーバーを取得します。システムのリソースは編集できません。

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

リクエスト例

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

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

レスポンス例
JSON
[]

パラメーター

パラメーターなし。

レスポンス

HTTP ステータス 200

現在の組織とシステムのファイアウォールリソースを配列として返します。

[]array

レスポンスの最上位は配列です。firewalls フィールドで包まれていません。

[].idstring

プラットフォーム側のファイアウォール識別子。共有システムリソースの場合は system。

[].systemboolean

システムファイアウォールかどうか。

[].providerIdstring | null

取得できる場合、プロバイダーのファイアウォール識別子。

[].namestring

保存された名前、またはプロバイダーのファイアウォール名。

[].statestring

プラットフォーム側のリソース状態。

[].statusstring

プロバイダーの状態。保存された状態スナップショットがない場合は unknown。

[].managedboolean

プロバイダーが関連付けたサーバーすべてが、この組織に所属し、表示可能かどうか。

[].rulesarray

表示可能な受信ルール。プロバイダーの末尾の既定拒否ルールを除きます。

[].rules[].displayNamestring

ルールの表示名。

[].rules[].protocolstring

ルールのプロトコル。

[].rules[].destPortsstring[]

宛先ポートまたはポート範囲。

[].rules[].ipv4string[]

IPv4 の送信元。

[].rules[].ipv6string[]

IPv6 の送信元。

[].rules[].actionstring

プロバイダーのルールアクション。

[].rules[].statusstring

プロバイダーのルール状態。

[].serversarray

表示可能な、適用先の組織サーバー。

[].servers[].idstring (ObjectId)

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

[].servers[].namestring

ホスト名。ない場合はプロバイダーのインスタンス ID を使用します。

[].servers[].statusstring

プロバイダーの適用状態。既定値は ok。