Gately 管理 API

Gately 管理 API は、スクリプトや自動化による一括管理に使用します。

認証：管理コンソールの「API トークン」ページでトークンを作成し、リクエストヘッダーに Authorization: Bearer gtl_xxxx を付与してください。

権限：各トークンには作成時に選択した権限のみが付与されます。形式は <モジュール>:read または <モジュール>:write で、書き込み権限は読み取り権限を含みます。アカウント、2 要素認証、トークン管理、およびバックアップ、復元、再起動、システム設定のエンドポイントはログインセッションでのみ使用できます。

リクエストボディには Content-Type: application/json を使用します。エラーは一律 {"error": "説明"} の形式で返されます。

「設定 → 機能モジュール」で無効にしたモジュールは API を提供せず、そのエンドポイントは 403 を返します。実行中のインスタンスの API ドキュメントにも表示されなくなります。

公式サイト：https://gately.cn

機械可読な定義は同じディレクトリの openapi.json（OpenAPI 3.0）を参照してください。

クイックスタート

# システムステータスを表示（status:read が必要）
curl -H "Authorization: Bearer gtl_xxxx" http://localhost:16680/api/status

# すべての DDNS タスクを一覧表示（ddns:read が必要）
curl -H "Authorization: Bearer gtl_xxxx" http://localhost:16680/api/ddns/tasks

# DDNS タスクを即時同期（ddns:write が必要。key は前の手順で返された一覧から取得）
curl -X POST -H "Authorization: Bearer gtl_xxxx" http://localhost:16680/api/ddns/tasks/<key>/sync

権限

権限ドメイン	名称	利用可能な権限
portforward	ポートフォワード	portforward:read、portforward:write
ddns	ダイナミック DNS	ddns:read、ddns:write
stun	STUN 穿透	stun:read、stun:write
tailscale	Tailscale ネットワーク	tailscale:read、tailscale:write
frp	frp イントラネット穿透	frp:read、frp:write
cloudflared	Cloudflare トンネル	cloudflared:read、cloudflared:write
ssl	SSL 証明書	ssl:read、ssl:write
waf	WAF ファイアウォール	waf:read、waf:write
webservice	Web サービス	webservice:read、webservice:write
guard	侵入防御	guard:read、guard:write
wol	Wake-on-LAN	wol:read、wol:write
webterminal	Web ターミナル	webterminal:read、webterminal:write
cron	スケジュールタスク	cron:read、cron:write
docker	Docker 管理	docker:read、docker:write
webdav	WebDAV サービス	webdav:read、webdav:write
ftp	FTP サービス	ftp:read、ftp:write
storage	ストレージマウント	storage:read、storage:write
notify	通知センター	notify:read、notify:write
nettools	ネットワーク診断	nettools:read、nettools:write
backup	設定バックアップ	backup:read、backup:write
status	システムステータス	status:read
logs	システムログ	logs:read
metrics	監視メトリクス（Prometheus）	metrics:read
import	Lucky 設定のインポート	import:write

ワイルドカード：*:read は全モジュールの読み取り専用、*:write または * は全モジュールの読み書きを表します。

ポートフォワード

メソッド	パス	必要な権限	説明
GET	/api/portforward/logs	portforward:read	モジュールの実行ログを表示
DELETE	/api/portforward/logs	portforward:write	モジュールの実行ログを消去
GET	/api/portforward/rules	portforward:read	ポートフォワードルール の一覧を取得
POST	/api/portforward/rules	portforward:write	ポートフォワードルール を追加
PUT	/api/portforward/rules/{key}	portforward:write	ポートフォワードルール を更新
DELETE	/api/portforward/rules/{key}	portforward:write	ポートフォワードルール を削除
PUT	/api/portforward/rules/{key}/enable	portforward:write	ポートフォワードルール の有効/無効を切り替え
PUT	/api/portforward/rules-order	portforward:write	ポートフォワードルール の並び順を変更
GET	/api/portforward/settings	portforward:read	ポートフォワードのグローバル設定を読み取り
PUT	/api/portforward/settings	portforward:write	ポートフォワードのグローバル設定を保存

ダイナミック DNS

メソッド	パス	必要な権限	説明
GET	/api/ddns/logs	ddns:read	モジュールの実行ログを表示
DELETE	/api/ddns/logs	ddns:write	モジュールの実行ログを消去
GET	/api/ddns/tasks	ddns:read	DDNS タスク の一覧を取得
POST	/api/ddns/tasks	ddns:write	DDNS タスク を追加
PUT	/api/ddns/tasks/{key}	ddns:write	DDNS タスク を更新
DELETE	/api/ddns/tasks/{key}	ddns:write	DDNS タスク を削除
PUT	/api/ddns/tasks/{key}/enable	ddns:write	DDNS タスク の有効/無効を切り替え
PUT	/api/ddns/tasks-order	ddns:write	DDNS タスク の並び順を変更
POST	/api/ddns/tasks/{key}/sync	ddns:write	DDNS タスクを即時同期
GET	/api/ddns/providers	ddns:read	対応する DNS プロバイダーと必要なパラメーターを一覧表示
GET	/api/ddns/netinterfaces	ddns:read	ローカルのネットワークインターフェースとアドレスを一覧表示
POST	/api/ddns/iptest	ddns:write	パブリック IP の取得をテスト
GET	/api/ddns/defaults	ddns:read	DDNS の既定値を読み取り
GET	/api/ddns/settings	ddns:read	DDNS のグローバル設定を読み取り
PUT	/api/ddns/settings	ddns:write	DDNS のグローバル設定を保存

STUN 穿透

メソッド	パス	必要な権限	説明
GET	/api/stun/logs	stun:read	モジュールの実行ログを表示
DELETE	/api/stun/logs	stun:write	モジュールの実行ログを消去
GET	/api/stun/rules	stun:read	STUN ルール の一覧を取得
POST	/api/stun/rules	stun:write	STUN ルール を追加
PUT	/api/stun/rules/{key}	stun:write	STUN ルール を更新
DELETE	/api/stun/rules/{key}	stun:write	STUN ルール を削除
PUT	/api/stun/rules/{key}/enable	stun:write	STUN ルール の有効/無効を切り替え
PUT	/api/stun/rules-order	stun:write	STUN ルール の並び順を変更
POST	/api/stun/rules/{key}/restart	stun:write	STUN ルールを 1 つ再起動
GET	/api/stun/netinterfaces	stun:read	ローカルのネットワークインターフェースとアドレスを一覧表示
GET	/api/stun/settings	stun:read	STUN のグローバル設定を読み取り
PUT	/api/stun/settings	stun:write	STUN のグローバル設定を保存

Tailscale ネットワーク

メソッド	パス	必要な権限	説明
GET	/api/tailscale/logs	tailscale:read	モジュールの実行ログを表示
DELETE	/api/tailscale/logs	tailscale:write	モジュールの実行ログを消去
GET	/api/tailscale/settings	tailscale:read	Tailscale 設定を読み取り
PUT	/api/tailscale/settings	tailscale:write	Tailscale 設定を保存
GET	/api/tailscale/status	tailscale:read	Tailscale の接続状態を表示
POST	/api/tailscale/restart	tailscale:write	Tailscale を再起動
POST	/api/tailscale/logout	tailscale:write	Tailscale からログアウト

frp イントラネット穿透

メソッド	パス	必要な権限	説明
GET	/api/frp/logs	frp:read	モジュールの実行ログを表示
DELETE	/api/frp/logs	frp:write	モジュールの実行ログを消去
GET	/api/frp/proxies	frp:read	エントリ の一覧を取得
POST	/api/frp/proxies	frp:write	エントリ を追加
PUT	/api/frp/proxies/{key}	frp:write	エントリ を更新
DELETE	/api/frp/proxies/{key}	frp:write	エントリ を削除
PUT	/api/frp/proxies/{key}/enable	frp:write	エントリ の有効/無効を切り替え
PUT	/api/frp/proxies-order	frp:write	エントリ の並び順を変更
POST	/api/frp/import	frp:write	既存の frpc / frps 設定をインポート（旧形式 ini と新形式 toml に対応）。apply が false の場合はプレビューのみ
GET	/api/frp/client	frp:read	frp クライアント設定を読み取り
PUT	/api/frp/client	frp:write	frp クライアント設定を保存
GET	/api/frp/server	frp:read	frp サーバー設定を読み取り
PUT	/api/frp/server	frp:write	frp サーバー設定を保存

Cloudflare トンネル

メソッド	パス	必要な権限	説明
GET	/api/cloudflared/logs	cloudflared:read	モジュールの実行ログを表示
DELETE	/api/cloudflared/logs	cloudflared:write	モジュールの実行ログを消去
GET	/api/cloudflared/tunnels	cloudflared:read	Cloudflare トンネル の一覧を取得
POST	/api/cloudflared/tunnels	cloudflared:write	Cloudflare トンネル を追加
PUT	/api/cloudflared/tunnels/{key}	cloudflared:write	Cloudflare トンネル を更新
DELETE	/api/cloudflared/tunnels/{key}	cloudflared:write	Cloudflare トンネル を削除
PUT	/api/cloudflared/tunnels/{key}/enable	cloudflared:write	Cloudflare トンネル の有効/無効を切り替え
PUT	/api/cloudflared/tunnels-order	cloudflared:write	Cloudflare トンネル の並び順を変更
POST	/api/cloudflared/tunnels/{key}/restart	cloudflared:write	Cloudflare トンネルを 1 つ再起動
GET	/api/cloudflared/settings	cloudflared:read	Cloudflare トンネル設定を読み取り
PUT	/api/cloudflared/settings	cloudflared:write	Cloudflare トンネルの設定を保存

SSL 証明書

メソッド	パス	必要な権限	説明
GET	/api/ssl/logs	ssl:read	モジュールの実行ログを表示
DELETE	/api/ssl/logs	ssl:write	モジュールの実行ログを消去
GET	/api/ssl/certs	ssl:read	証明書 の一覧を取得
POST	/api/ssl/certs	ssl:write	証明書 を追加
PUT	/api/ssl/certs/{key}	ssl:write	証明書 を更新
DELETE	/api/ssl/certs/{key}	ssl:write	証明書 を削除
PUT	/api/ssl/certs/{key}/enable	ssl:write	証明書 の有効/無効を切り替え
PUT	/api/ssl/certs-order	ssl:write	証明書 の並び順を変更
POST	/api/ssl/certs/{key}/renew	ssl:write	証明書を即時発行または更新
GET	/api/ssl/certs/{key}/download	ssl:write	証明書と秘密鍵をダウンロード
POST	/api/ssl/certs/{key}/deploy	ssl:write	証明書を今すぐデプロイ
GET	/api/ssl/deploy-targets	ssl:read	選択できるデプロイ先を一覧表示
GET	/api/ssl/providers	ssl:read	対応する DNS 検証プロバイダーを一覧表示
GET	/api/ssl/settings	ssl:read	証明書のグローバル設定を読み取り
PUT	/api/ssl/settings	ssl:write	証明書のグローバル設定を保存

WAF ファイアウォール

メソッド	パス	必要な権限	説明
GET	/api/waf/logs	waf:read	モジュールの実行ログを表示
DELETE	/api/waf/logs	waf:write	モジュールの実行ログを消去
GET	/api/waf/instances	waf:read	WAF インスタンス の一覧を取得
POST	/api/waf/instances	waf:write	WAF インスタンス を追加
PUT	/api/waf/instances/{key}	waf:write	WAF インスタンス を更新
DELETE	/api/waf/instances/{key}	waf:write	WAF インスタンス を削除
PUT	/api/waf/instances/{key}/enable	waf:write	WAF インスタンス の有効/無効を切り替え
PUT	/api/waf/instances-order	waf:write	WAF インスタンス の並び順を変更
GET	/api/waf/crs	waf:read	OWASP CRS ルールファイルを一覧表示
GET	/api/waf/crs/{file}	waf:read	CRS ルールファイルを 1 つ読み取り

Web サービス

メソッド	パス	必要な権限	説明
GET	/api/webservice/logs	webservice:read	モジュールの実行ログを表示
DELETE	/api/webservice/logs	webservice:write	モジュールの実行ログを消去
GET	/api/webservice/listeners	webservice:read	Web サービスのリッスン の一覧を取得
POST	/api/webservice/listeners	webservice:write	Web サービスのリッスン を追加
PUT	/api/webservice/listeners/{key}	webservice:write	Web サービスのリッスン を更新
DELETE	/api/webservice/listeners/{key}	webservice:write	Web サービスのリッスン を削除
PUT	/api/webservice/listeners/{key}/enable	webservice:write	Web サービスのリッスン の有効/無効を切り替え
PUT	/api/webservice/listeners-order	webservice:write	Web サービスのリッスン の並び順を変更
GET	/api/webservice/iplists	webservice:read	订阅 IP の一覧を取得列表
POST	/api/webservice/iplists	webservice:write	購読 IP リスト を追加
PUT	/api/webservice/iplists/{key}	webservice:write	購読 IP リスト を更新
DELETE	/api/webservice/iplists/{key}	webservice:write	購読 IP リスト を削除
PUT	/api/webservice/iplists/{key}/enable	webservice:write	購読 IP リスト の有効/無効を切り替え
PUT	/api/webservice/iplists-order	webservice:write	購読 IP リスト の並び順を変更
POST	/api/webservice/iplists/{key}/refresh	webservice:write	購読 IP リストを今すぐ更新
POST	/api/webservice/import/nginx	webservice:write	nginx 設定をインポート
GET	/api/webservice/settings	webservice:read	Web サービスのグローバル設定を読み取り
POST	/api/webservice/totp-secret	webservice:write	共有ユーザーの新しい TOTP 鍵を生成（保存はせず、設定保存後に有効）
PUT	/api/webservice/settings	webservice:write	Web サービスのグローバル設定を保存
GET	/api/webservice/stats	webservice:read	サイトの分単位統計（?listener=&site=&minutes=）
GET	/api/webservice/metrics	webservice:read	Prometheus テキスト形式のメトリクス
GET	/api/webservice/bans	webservice:read	現在ブロックされている IP
POST	/api/webservice/bans	webservice:write	IP を手動でブロック
DELETE	/api/webservice/bans	webservice:write	ブロックを解除（body は {"key": アドレス}）
GET	/api/webservice/geoip	webservice:read	GeoIP データベースの状態
POST	/api/webservice/geoip/upload	webservice:write	GeoIP データベースをアップロード（multipart フィールド file、.mmdb）
POST	/api/webservice/geoip/download	webservice:write	URL から GeoIP データベース（.mmdb）をダウンロード
DELETE	/api/webservice/geoip	webservice:write	GeoIP データベースを削除

侵入防御

メソッド	パス	必要な権限	説明
GET	/api/guard/logs	guard:read	モジュールの実行ログを表示
DELETE	/api/guard/logs	guard:write	モジュールの実行ログを消去
GET	/api/guard/jails	guard:read	エントリ の一覧を取得
POST	/api/guard/jails	guard:write	エントリ を追加
PUT	/api/guard/jails/{key}	guard:write	エントリ を更新
DELETE	/api/guard/jails/{key}	guard:write	エントリ を削除
PUT	/api/guard/jails/{key}/enable	guard:write	エントリ の有効/無効を切り替え
PUT	/api/guard/jails-order	guard:write	エントリ の並び順を変更
GET	/api/guard/presets	guard:read	よく使われるサービスのルールテンプレート
POST	/api/guard/jails/test	guard:write	ログのサンプルでフィルターをテスト
GET	/api/guard/status	guard:read	ファイアウォール同期の状態と実行環境
GET	/api/guard/settings	guard:read	グローバル設定
PUT	/api/guard/settings	guard:write	全体設定を変更
GET	/api/guard/bans	guard:read	現在ブロック中の IP
POST	/api/guard/bans	guard:write	IP またはネットワークを手動でブロック
DELETE	/api/guard/bans	guard:write	ブロックを解除（body は {"key": アドレス}）
GET	/api/guard/firewall/rules	guard:read	Gately が nftables に書き込んだルール（テキスト）

Wake-on-LAN

メソッド	パス	必要な権限	説明
GET	/api/wol/logs	wol:read	モジュールの実行ログを表示
DELETE	/api/wol/logs	wol:write	モジュールの実行ログを消去
GET	/api/wol/devices	wol:read	デバイスをウェイクアップ の一覧を取得
POST	/api/wol/devices	wol:write	デバイスをウェイクアップ を追加
PUT	/api/wol/devices/{key}	wol:write	デバイスをウェイクアップ を更新
DELETE	/api/wol/devices/{key}	wol:write	デバイスをウェイクアップ を削除
PUT	/api/wol/devices/{key}/enable	wol:write	デバイスをウェイクアップ の有効/無効を切り替え
PUT	/api/wol/devices-order	wol:write	デバイスをウェイクアップ の並び順を変更
POST	/api/wol/devices/{key}/wake	wol:write	デバイスにウェイクアップのマジックパケットを送信
GET	/api/wol/status	wol:read	デバイスのオンライン状態を表示

Web ターミナル

メソッド	パス	必要な権限	説明
GET	/api/webterminal/logs	webterminal:read	モジュールの実行ログを表示
DELETE	/api/webterminal/logs	webterminal:write	モジュールの実行ログを消去
GET	/api/webterminal/connections	webterminal:read	ターミナル接続 の一覧を取得
POST	/api/webterminal/connections	webterminal:write	ターミナル接続 を追加
PUT	/api/webterminal/connections/{key}	webterminal:write	ターミナル接続 を更新
DELETE	/api/webterminal/connections/{key}	webterminal:write	ターミナル接続 を削除
PUT	/api/webterminal/connections/{key}/enable	webterminal:write	ターミナル接続 の有効/無効を切り替え
PUT	/api/webterminal/connections-order	webterminal:write	ターミナル接続 の並び順を変更
DELETE	/api/webterminal/connections/{key}/hostkey	webterminal:write	記録済みのホストキーをクリア
POST	/api/webterminal/connections/{key}/test	webterminal:write	保存済みの接続をテスト
POST	/api/webterminal/connections/test	webterminal:write	一時的な接続パラメーターをテスト
PUT	/api/webterminal/connections/{key}/quickaccess	webterminal:write	接続のクイックアクセスを設定
GET	/api/webterminal/credentials	webterminal:read	エントリ の一覧を取得
POST	/api/webterminal/credentials	webterminal:write	エントリ を追加
PUT	/api/webterminal/credentials/{key}	webterminal:write	エントリ を更新
DELETE	/api/webterminal/credentials/{key}	webterminal:write	エントリ を削除
PUT	/api/webterminal/credentials/{key}/enable	webterminal:write	エントリ の有効/無効を切り替え
PUT	/api/webterminal/credentials-order	webterminal:write	エントリ の並び順を変更
GET	/api/webterminal/connections/{key}/ws	webterminal:write	ターミナルセッションを開く（WebSocket）
GET	/api/webterminal/sessions/{id}/ws	webterminal:write	既存のターミナルセッションに接続（WebSocket）
GET	/api/webterminal/sessions	webterminal:read	ターミナルセッションを一覧表示
GET	/api/webterminal/sessions/{id}	webterminal:read	ターミナルセッションの詳細を表示
PUT	/api/webterminal/sessions/{id}/remark	webterminal:write	ターミナルセッションのメモを変更
GET	/api/webterminal/sessions/{id}/stats	webterminal:read	ターミナルセッションの統計を表示
DELETE	/api/webterminal/sessions/{id}	webterminal:write	ターミナルセッションを閉じる
GET	/api/webterminal/security	ログインセッションのみ	ターミナルのセキュリティ設定の状態を表示
POST	/api/webterminal/security/agreement	ログインセッションのみ	ターミナル利用規約に同意
POST	/api/webterminal/security/2fa/setup	ログインセッションのみ	ターミナルの 2 要素認証シークレットを生成
POST	/api/webterminal/security/2fa/enable	ログインセッションのみ	ターミナルの 2 要素認証を有効化
POST	/api/webterminal/security/2fa/disable	ログインセッションのみ	ターミナルの 2 要素認証を無効化
POST	/api/webterminal/security/verify2fa	ログインセッションのみ	ターミナルの 2 要素認証コードを検証
GET	/api/webterminal/security/check2fa	ログインセッションのみ	ターミナルの 2 要素認証が完了しているか確認
GET	/api/webterminal/sftp/{key}/list	webterminal:read	リモートディレクトリを一覧表示
GET	/api/webterminal/sftp/{key}/read	webterminal:write	リモートファイルを読み取り
POST	/api/webterminal/sftp/{key}/write	webterminal:write	リモートファイルに書き込み
POST	/api/webterminal/sftp/{key}/upload	webterminal:write	リモートホストにファイルをアップロード
POST	/api/webterminal/sftp/{key}/mkdir	webterminal:write	リモートディレクトリを作成
POST	/api/webterminal/sftp/{key}/touch	webterminal:write	リモートに空ファイルを作成
POST	/api/webterminal/sftp/{key}/rename	webterminal:write	リモートファイルの名前変更または移動
POST	/api/webterminal/sftp/{key}/copy	webterminal:write	リモートファイルをコピー
POST	/api/webterminal/sftp/{key}/chmod	webterminal:write	リモートファイルの権限を変更
DELETE	/api/webterminal/sftp/{key}/remove	webterminal:write	リモートファイルを削除
POST	/api/webterminal/sftp/{key}/compress	webterminal:write	リモートホスト上でファイルを圧縮
POST	/api/webterminal/sftp/{key}/decompress	webterminal:write	リモートホスト上でファイルを展開
GET	/api/webterminal/sftp/{key}/preview-archive	webterminal:write	リモートアーカイブの内容をプレビュー
GET	/api/webterminal/settings	webterminal:read	Web ターミナル設定を読み取り
PUT	/api/webterminal/settings	webterminal:write	Web ターミナル設定を保存
GET	/api/webterminal/shells	webterminal:read	ローカルで利用可能なシェルを一覧表示
GET	/api/webterminal/globalshortcuts	webterminal:read	グローバルクイックコマンドを読み取り
PUT	/api/webterminal/globalshortcuts	webterminal:write	グローバルクイックコマンドを保存
GET	/api/webterminal/splitlayout	webterminal:read	分割レイアウトを読み取り
PUT	/api/webterminal/splitlayout	webterminal:write	分割レイアウトを保存
DELETE	/api/webterminal/splitlayout	webterminal:write	分割レイアウトをクリア

スケジュールタスク

メソッド	パス	必要な権限	説明
GET	/api/cron/logs	cron:read	モジュールの実行ログを表示
DELETE	/api/cron/logs	cron:write	モジュールの実行ログを消去
GET	/api/cron/tasks	cron:read	スケジュールタスク の一覧を取得
POST	/api/cron/tasks	cron:write	スケジュールタスク を追加
PUT	/api/cron/tasks/{key}	cron:write	スケジュールタスク を更新
DELETE	/api/cron/tasks/{key}	cron:write	スケジュールタスク を削除
PUT	/api/cron/tasks/{key}/enable	cron:write	スケジュールタスク の有効/無効を切り替え
PUT	/api/cron/tasks-order	cron:write	スケジュールタスク の並び順を変更
POST	/api/cron/tasks/{key}/run	cron:write	スケジュールタスクを即時実行
POST	/api/cron/parse	cron:write	Cron 式を解析してプレビュー

Docker 管理

メソッド	パス	必要な権限	説明
GET	/api/docker/logs	docker:read	モジュールの実行ログを表示
DELETE	/api/docker/logs	docker:write	モジュールの実行ログを消去
GET	/api/docker/tasks	docker:read	バックグラウンドタスクを一覧表示
GET	/api/docker/tasks/{id}	docker:read	バックグラウンドタスクの進行状況と出力を表示
DELETE	/api/docker/tasks	docker:write	終了済みのバックグラウンドタスクをクリーンアップ
GET	/api/docker/images	docker:read	イメージを一覧表示
POST	/api/docker/images/pull	docker:write	イメージを取得
POST	/api/docker/images/push	docker:write	イメージをプッシュ
POST	/api/docker/images/search	docker:write	イメージを検索
POST	/api/docker/images/load	docker:write	イメージファイルをインポート
POST	/api/docker/images/build	docker:write	イメージをビルド
GET	/api/docker/images/{id}	docker:read	イメージの詳細を表示
POST	/api/docker/images/{id}/tag	docker:write	イメージにタグを付与
DELETE	/api/docker/images/{id}	docker:write	イメージを削除
GET	/api/docker/images/{id}/export	docker:write	イメージをエクスポート
GET	/api/docker/networks	docker:read	ネットワークを一覧表示
POST	/api/docker/networks	docker:write	ネットワークを作成
DELETE	/api/docker/networks/{id}	docker:write	ネットワークを削除
POST	/api/docker/networks/{id}/connect	docker:write	コンテナをネットワークに接続
POST	/api/docker/networks/{id}/disconnect	docker:write	コンテナをネットワークから切断
GET	/api/docker/volumes	docker:read	ボリュームを一覧表示
POST	/api/docker/volumes	docker:write	データボリュームを作成
DELETE	/api/docker/volumes/{name}	docker:write	データボリュームを削除
GET	/api/docker/volumes/{name}/export	docker:write	データボリュームをエクスポート
POST	/api/docker/volumes/{name}/import	docker:write	データボリュームにデータをインポート
GET	/api/docker/compose/projects	docker:read	Compose プロジェクトを一覧表示
POST	/api/docker/compose/projects	docker:write	Compose プロジェクトを作成
POST	/api/docker/compose/{project}/up	docker:write	Compose プロジェクトを起動
POST	/api/docker/compose/{project}/pull	docker:write	Compose プロジェクトのイメージを取得
POST	/api/docker/compose/{project}/{action}	docker:write	Compose プロジェクトに対して操作を実行
GET	/api/docker/compose/{project}/config	docker:write	Compose 設定ファイルを読み取り
PUT	/api/docker/compose/{project}/config	docker:write	Compose 設定ファイルを保存
GET	/api/docker/compose/{project}/logs	docker:read	Compose プロジェクトのログを表示
DELETE	/api/docker/compose/{project}	docker:write	Compose プロジェクトを削除
GET	/api/docker/info	docker:read	Docker エンジン情報を表示
GET	/api/docker/disk-usage	docker:read	Docker のディスク使用量を表示
POST	/api/docker/prune	docker:write	不要な Docker リソースをクリーンアップ
GET	/api/docker/settings	docker:read	Docker モジュール設定を読み取り
PUT	/api/docker/settings	docker:write	Docker モジュールの設定を保存
GET	/api/docker/containers	docker:read	コンテナを一覧表示
POST	/api/docker/containers	docker:write	コンテナを作成
POST	/api/docker/containers/check-all	docker:write	すべてのコンテナイメージの更新を確認
POST	/api/docker/containers/upgrade-batch	docker:write	コンテナを一括アップグレード
POST	/api/docker/images/upgrade-check	docker:write	イメージに新しいバージョンがあるか確認
GET	/api/docker/containers/{id}	docker:read	コンテナの詳細を表示
DELETE	/api/docker/containers/{id}	docker:write	コンテナを削除
POST	/api/docker/containers/{id}/edit	docker:write	コンテナ設定を変更して再作成
POST	/api/docker/containers/{id}/rename	docker:write	コンテナの名前を変更
POST	/api/docker/containers/{id}/commit	docker:write	コンテナをイメージとしてコミット
POST	/api/docker/containers/{id}/check	docker:write	コンテナイメージに更新があるか確認
POST	/api/docker/containers/{id}/upgrade	docker:write	コンテナイメージをアップグレードして再作成
POST	/api/docker/containers/{id}/{action}	docker:write	コンテナに対して操作を実行
GET	/api/docker/containers/{id}/logs	docker:read	コンテナのログを表示
GET	/api/docker/containers/{id}/stats	docker:read	コンテナのリソース使用量を表示
GET	/api/docker/containers/{id}/processes	docker:read	コンテナ内のプロセスを表示
GET	/api/docker/containers/{id}/files/list	docker:read	コンテナ内のディレクトリを一覧表示
GET	/api/docker/containers/{id}/files/read	docker:write	コンテナ内のファイルを読み取り
GET	/api/docker/containers/{id}/files/download	docker:write	コンテナ内のファイルをダウンロード
POST	/api/docker/containers/{id}/files/write	docker:write	コンテナ内のファイルに書き込み
POST	/api/docker/containers/{id}/files/mkdir	docker:write	コンテナ内にディレクトリを作成
POST	/api/docker/containers/{id}/files/rename	docker:write	コンテナ内のファイルの名前を変更
POST	/api/docker/containers/{id}/files/upload	docker:write	コンテナにファイルをアップロード
DELETE	/api/docker/containers/{id}/files	docker:write	コンテナ内のファイルを削除
GET	/api/docker/containers/{id}/exec	docker:write	コンテナ内でターミナルを開く（WebSocket）

WebDAV サービス

メソッド	パス	必要な権限	説明
GET	/api/webdav/logs	webdav:read	モジュールの実行ログを表示
DELETE	/api/webdav/logs	webdav:write	モジュールの実行ログを消去
GET	/api/webdav/settings	webdav:read	WebDAV 設定を読み取り
PUT	/api/webdav/settings	webdav:write	WebDAV 設定を保存

FTP サービス

メソッド	パス	必要な権限	説明
GET	/api/ftp/logs	ftp:read	モジュールの実行ログを表示
DELETE	/api/ftp/logs	ftp:write	モジュールの実行ログを消去
GET	/api/ftp/settings	ftp:read	FTP 設定を読み取り
PUT	/api/ftp/settings	ftp:write	FTP 設定を保存

ストレージマウント

メソッド	パス	必要な権限	説明
GET	/api/storage/logs	storage:read	モジュールの実行ログを表示
DELETE	/api/storage/logs	storage:write	モジュールの実行ログを消去
GET	/api/storage/mounts	storage:read	エントリ の一覧を取得
POST	/api/storage/mounts	storage:write	エントリ を追加
PUT	/api/storage/mounts/{key}	storage:write	エントリ を更新
DELETE	/api/storage/mounts/{key}	storage:write	エントリ を削除
PUT	/api/storage/mounts/{key}/enable	storage:write	エントリ の有効/無効を切り替え
PUT	/api/storage/mounts-order	storage:write	エントリ の並び順を変更
GET	/api/storage/files/{key}/list	storage:read	ストレージのディレクトリを一覧表示
GET	/api/storage/files/{key}/download	storage:write	ストレージのファイルをダウンロード
POST	/api/storage/files/{key}/upload	storage:write	ストレージにファイルをアップロード
POST	/api/storage/files/{key}/mkdir	storage:write	ストレージディレクトリを作成
POST	/api/storage/files/{key}/rename	storage:write	ストレージのファイルの名前変更または移動
DELETE	/api/storage/files/{key}	storage:write	ストレージのファイルを削除

通知センター

メソッド	パス	必要な権限	説明
GET	/api/notify/logs	notify:read	モジュールの実行ログを表示
DELETE	/api/notify/logs	notify:write	モジュールの実行ログを消去
GET	/api/notify/channels	notify:read	通知チャネル の一覧を取得
POST	/api/notify/channels	notify:write	通知チャネル を追加
PUT	/api/notify/channels/{key}	notify:write	通知チャネル を更新
DELETE	/api/notify/channels/{key}	notify:write	通知チャネル を削除
PUT	/api/notify/channels/{key}/enable	notify:write	通知チャネル の有効/無効を切り替え
PUT	/api/notify/channels-order	notify:write	通知チャネル の並び順を変更
GET	/api/notify/rules	notify:read	通知ルール の一覧を取得
POST	/api/notify/rules	notify:write	通知ルール を追加
PUT	/api/notify/rules/{key}	notify:write	通知ルール を更新
DELETE	/api/notify/rules/{key}	notify:write	通知ルール を削除
PUT	/api/notify/rules/{key}/enable	notify:write	通知ルール の有効/無効を切り替え
PUT	/api/notify/rules-order	notify:write	通知ルール の並び順を変更
GET	/api/notify/event-types	notify:read	購読可能なイベントタイプ
GET	/api/notify/history	notify:read	最近の配信履歴
POST	/api/notify/channels/{key}/test	notify:write	チャネルにテスト通知を送信

ネットワーク診断

メソッド	パス	必要な権限	説明
GET	/api/nettools/logs	nettools:read	モジュールの実行ログを表示
DELETE	/api/nettools/logs	nettools:write	モジュールの実行ログを消去
POST	/api/nettools/run	nettools:write	診断ツールを実行してタスクを返す（tool: ping / traceroute / tcp / dns / speed / scan）
GET	/api/nettools/tasks	nettools:read	最近の診断タスク
GET	/api/nettools/tasks/{id}	nettools:read	タスクの詳細と出力
DELETE	/api/nettools/tasks/{id}	nettools:write	実行中のタスクをキャンセル、または終了済みのタスクを削除
GET	/api/nettools/settings	nettools:read	診断設定
PUT	/api/nettools/settings	nettools:write	スキャン禁止リストを変更
GET	/api/nettools/networks	nettools:read	LAN スキャンに使用できるローカルのネットワークセグメント

設定バックアップ

メソッド	パス	必要な権限	説明
GET	/api/backup/logs	backup:read	モジュールの実行ログを表示
DELETE	/api/backup/logs	backup:write	モジュールの実行ログを消去
GET	/api/backup/targets	backup:read	バックアップ先 の一覧を取得
POST	/api/backup/targets	backup:write	バックアップ先 を追加
PUT	/api/backup/targets/{key}	backup:write	バックアップ先 を更新
DELETE	/api/backup/targets/{key}	backup:write	バックアップ先 を削除
PUT	/api/backup/targets/{key}/enable	backup:write	バックアップ先 の有効/無効を切り替え
PUT	/api/backup/targets-order	backup:write	バックアップ先 の並び順を変更
GET	/api/backup/settings	backup:read	バックアップ設定
PUT	/api/backup/settings	backup:write	バックアップ設定を変更（パスフレーズにプレースホルダーを渡すと変更なし）
POST	/api/backup/run	backup:write	今すぐバックアップを 1 回実行
GET	/api/backup/status	backup:read	直近のバックアップ結果と次回実行時刻
GET	/api/backup/mounts	backup:read	バックアップ先として使用できるストレージのマウントポイント
GET	/api/backup/local	ログインセッションのみ	ローカルバックアップファイル一覧
GET	/api/backup/local/{name}	ログインセッションのみ	ローカルバックアップファイルをダウンロード

システム

メソッド	パス	必要な権限	説明
GET	/api/session	任意の有効なトークン	現在の認証 ID を表示
GET	/api/status	status:read	システムと各モジュールの状態を表示
GET	/api/logs	logs:read	システムログを表示
GET	/api/system/settings	ログインセッションのみ	グローバル設定を読み取り
PUT	/api/system/settings	ログインセッションのみ	グローバル設定を保存
GET	/api/system/info	status:read	システム情報を表示
GET	/api/system/update	status:read	新しいバージョンを確認
POST	/api/system/upgrade	ログインセッションのみ	最新バージョンへオンラインアップグレード
GET	/api/system/upgrade/status	ログインセッションのみ	オンラインアップグレードの進捗を確認
POST	/api/system/upgrade/cancel	ログインセッションのみ	オンラインアップグレードを取消
POST	/api/system/upgrade/upload	ログインセッションのみ	アップロードしたパッケージでアップグレード
GET	/api/system/backup	ログインセッションのみ	設定バックアップをダウンロード
GET	/api/system/diagnostics	ログインセッションのみ	マスク済み診断パッケージをエクスポート
GET	/api/audit	ログインセッションのみ	操作監査ログを検索
GET	/api/metrics	metrics:read	Prometheus グローバルメトリクス
GET	/api/history	ログインセッションのみ	設定の履歴バージョンを一覧表示
GET	/api/history/{name}/{id}/diff	ログインセッションのみ	履歴バージョンと現在の設定を比較
POST	/api/history/{name}/{id}/restore	ログインセッションのみ	設定を履歴バージョンにロールバック
POST	/api/system/restore	ログインセッションのみ	バックアップから設定を復元
POST	/api/system/restart	ログインセッションのみ	Gately を再起動
POST	/api/system/selfcheck	ログインセッションのみ	ネットワークと設定のセルフチェック
GET	/api/system/onboarding	ログインセッションのみ	初回起動セットアップが必要かどうか
POST	/api/system/onboarding/dismiss	ログインセッションのみ	初回起動セットアップを完了またはスキップ
GET	/api/openapi.json	任意の有効なトークン	この API の OpenAPI 定義を取得

設定のインポート

メソッド	パス	必要な権限	説明
POST	/api/import/lucky	import:write	Lucky 設定をインポート

API トークン

メソッド	パス	必要な権限	説明
GET	/api/tokens	ログインセッションのみ	API トークンを一覧表示
GET	/api/tokens/scopes	ログインセッションのみ	付与可能な権限ドメインを一覧表示
POST	/api/tokens	ログインセッションのみ	API トークンを作成
PUT	/api/tokens/{id}	ログインセッションのみ	API トークンの名前、権限、有効期限、有効/無効を変更
POST	/api/tokens/{id}/regenerate	ログインセッションのみ	トークンの平文を再生成
DELETE	/api/tokens/{id}	ログインセッションのみ	API トークンを削除

アカウント

メソッド	パス	必要な権限	説明
PUT	/api/account	ログインセッションのみ	管理者のユーザー名とパスワードを変更
GET	/api/account/passkeys	ログインセッションのみ	登録済みの Passkey を一覧表示
POST	/api/account/passkeys/begin	ログインセッションのみ	Passkey の登録を開始
POST	/api/account/passkeys	ログインセッションのみ	Passkey の登録を完了
DELETE	/api/account/passkeys/{id}	ログインセッションのみ	Passkey を削除
GET	/api/account/users	ログインセッションのみ	読み取り専用アカウントを一覧表示
POST	/api/account/users	ログインセッションのみ	読み取り専用アカウントを作成
PUT	/api/account/users/{name}	ログインセッションのみ	読み取り専用アカウントのパスワードをリセット
DELETE	/api/account/users/{name}	ログインセッションのみ	読み取り専用アカウントを削除
GET	/api/account/totp	ログインセッションのみ	2 要素認証の状態を表示
POST	/api/account/totp/setup	ログインセッションのみ	2 要素認証のシークレットを生成
POST	/api/account/totp/enable	ログインセッションのみ	2 要素認証を有効化
POST	/api/account/totp/disable	ログインセッションのみ	2 要素認証を無効化

データ構造

backup.LocalFile

フィールド	型
modTime	時刻 (RFC 3339)
name	string
size	integer

backup.Result

フィールド	型
error	string
file	string
ok	boolean
pruned	integer
target	string

backup.Settings

フィールド	型
enable	boolean
keep	integer
localEnable	boolean
password	string
schedule	string

backup.Status

フィールド	型
lastRun	時刻 (RFC 3339)
manual	boolean
nextRun	時刻 (RFC 3339)
results	配列 of backup.Result
running	boolean

backup.Target

フィールド	型
dir	string
enable	boolean
key	string
mount	string
name	string

backup.settingsView

フィールド	型
enable	boolean
hasPassword	boolean
keep	integer
localEnable	boolean
password	string
schedule	string

banlist.Entry

フィールド	型
count	integer
created	時刻 (RFC 3339)
key	string
reason	string
source	string
until	時刻 (RFC 3339)

cloudflared.Tunnel

フィールド	型
edgeIpVersion	string
enable	boolean
key	string
mode	string
name	string
protocol	string
remark	string
service	string
token	string

cron.Task

フィールド	型
command	string
enable	boolean
http	webhook.Config
key	string
name	string
remark	string
spec	string
type	string

crud.enableRequest

フィールド	型
enable	boolean

crud.orderRequest

フィールド	型
keys	配列 of string

ddns.Record

フィールド	型
enable	boolean
key	string
line	string
remark	string
sub	string
ttl	integer
type	string
value	string
zone	string

ddns.Task

フィールド	型
credentials	dnsprovider.Credentials
enable	boolean
forceInterval	integer
httpTimeout	integer
interval	integer
ipv4	ipsource.Source
ipv6	ipsource.Source
key	string
name	string
provider	string
records	配列 of ddns.Record
remark	string
webhook	webhook.Config

dnsprovider.Credentials

フィールド	型
extra	マップ of string
id	string
secret	string

events.TypeInfo

フィールド	型
level	string
name	string
type	string

frp.ClientSettings

フィールド	型
binPath	string
enable	boolean
protocol	string
serverAddr	string
serverPort	integer
token	string
user	string

frp.ImportRequest

フィールド	型
apply	boolean
content	string
proxyMode	string
role	string

frp.ImportResponse

フィールド	型
added	integer
applied	boolean
client	frp.ClientSettings
proxies	配列 of frp.Proxy
role	string
server	frp.ServerSettings
warnings	配列 of string

frp.Proxy

フィールド	型
customDomains	配列 of string
enable	boolean
key	string
localIp	string
localPort	integer
name	string
remark	string
remotePort	integer
secretKey	string
subdomain	string
type	string

frp.ServerSettings

フィールド	型
allowPorts	string
binPath	string
bindPort	integer
dashboardAddr	string
dashboardPort	integer
dashboardPwd	string
dashboardUser	string
enable	boolean
subdomainHost	string
token	string
vhostHttpPort	integer
vhostHttpsPort	integer

geoip.Info

フィールド	型
buildTime	時刻 (RFC 3339)
loaded	boolean
size	integer
type	string

guard.BanView

フィールド	型
count	integer
created	時刻 (RFC 3339)
jail	string
key	string
reason	string
source	string
until	時刻 (RFC 3339)

guard.FirewallStatus

フィールド	型
active	boolean
checkedAt	時刻 (RFC 3339)
dropped	マップ of integer
enabled	boolean
error	string
hits	マップ of integer
openPorts	integer
reason	string
trapPorts	string
trapSkipped	配列 of integer
version	string

guard.Jail

フィールド	型
banTime	integer
enable	boolean
filter	string
findTime	integer
ignore	string
key	string
maxRetry	integer
name	string
preset	string
remark	string
source	string
target	string

guard.Platform

フィールド	型
docker	boolean
inDocker	boolean
journal	boolean
os	string

guard.ScanSettings

フィールド	型
banSeconds	integer
enable	boolean
excludePorts	string
threshold	integer

guard.Settings

フィールド	型
banSeconds	integer
firewall	boolean
ignoreList	配列 of string
ignorePrivate	boolean
increment	boolean
maxBanSeconds	integer
scan	guard.ScanSettings
trap	guard.TrapSettings

guard.Status

フィールド	型
bans	integer
firewall	guard.FirewallStatus
platform	guard.Platform
userTrapPorts	配列 of integer

guard.TestResult

フィールド	型
host	string
ignored	boolean
line	string
matched	boolean

guard.TrapSettings

フィールド	型
banSeconds	integer
enable	boolean
ports	string

guard.banRequest

フィールド	型
key	string
reason	string
seconds	integer

guard.testRequest

フィールド	型
filter	string
ignore	string
lines	string

ipsource.Source

フィールド	型
command	string
enable	boolean
interface	string
regex	string
type	string
urls	配列 of string

nettools.Request

フィールド	型
cidr	string
count	integer
ports	string
seconds	integer
server	string
target	string
tool	string
type	string
url	string

nettools.Settings

フィールド	型
deny	配列 of string

nettools.Task

フィールド	型
error	string
finished	時刻 (RFC 3339)
id	string
lines	配列 of string
result	任意
started	時刻 (RFC 3339)
status	string
title	string
tool	string

notify.Channel

フィールド	型
enable	boolean
from	string
host	string
key	string
kind	string
name	string
port	integer
remark	string
secret	string
security	string
target	string
url	string
user	string
webhook	webhook.Config

notify.Record

フィールド	型
channel	string
error	string
ok	boolean
rule	string
time	時刻 (RFC 3339)
title	string
type	string

notify.Rule

フィールド	型
channels	配列 of string
enable	boolean
events	配列 of string
key	string
minLevel	string
name	string
silence	integer

portforward.Rule

フィールド	型
enable	boolean
key	string
listenAddress	string
listenPorts	string
maxConnections	integer
mode	string
name	string
protocols	配列 of string
proxyProtocol	string
remark	string
sniRoutes	配列 of portforward.SNIRoute
targetAddresses	配列 of string
targetPorts	string
udpSessionTimeout	integer

portforward.SNIRoute

フィールド	型
domains	配列 of string
name	string
proxyProtocol	string
targetAddresses	配列 of string
targetPort	integer

ssl.ACMEConfig

フィールド	型
ca	string
challenge	string
credentials	dnsprovider.Credentials
directoryUrl	string
disableAuthoritativeCheck	boolean
domains	配列 of string
eabHmac	string
eabKid	string
email	string
httpPort	integer
keyType	string
propagationTimeout	integer
provider	string
resolvers	配列 of string
skipPropagationCheck	boolean
zone	string

ssl.Cert

フィールド	型
acme	ssl.ACMEConfig
certFile	string
certPem	string
deploys	配列 of ssl.Deploy
enable	boolean
issuerPem	string
key	string
keyFile	string
keyPem	string
mapping	ssl.Mapping
remark	string
source	string
updatedAt	時刻 (RFC 3339)

ssl.Deploy

フィールド	型
certName	string
command	string
connection	string
containers	配列 of string
deployedAt	時刻 (RFC 3339)
deployedHash	string
dir	string
enable	boolean
keyName	string
remark	string
type	string

ssl.Mapping

フィールド	型
dir	string
enable	boolean
script	string

storage.Mount

フィールド	型
domain	string
enable	boolean
key	string
name	string
password	string
path	string
readOnly	boolean
remark	string
skipVerify	boolean
type	string
url	string
username	string

storage.MountInfo

フィールド	型
enable	boolean
key	string
name	string
readOnly	boolean
type	string

stun.Bind

フィールド	型
interface	string
ip	string
mode	string
regex	string

stun.Rule

フィールド	型
autoRetry	boolean
bind	stun.Bind
disableCheck	boolean
disableForward	boolean
enable	boolean
heartbeatInterval	integer
keepAliveServers	配列 of string
key	string
localPort	integer
maxConnections	integer
name	string
natpmp	boolean
natpmpGateway	string
protocol	string
remark	string
retryInterval	integer
script	string
scriptEnable	boolean
stunServers	配列 of string
stunTimeout	integer
targetAddresses	配列 of string
targetPort	integer
udpSessionTimeout	integer
upnp	boolean
upnpControlUrl	string
upnpGateway	string
upnpInternalPort	integer
upnpLocalHost	string
useGlobalServers	boolean
useGlobalWebhook	boolean
webhook	webhook.Config
webhookOnlyOnChange	boolean

waf.Instance

フィールド	型
bodyLimitAction	string
bodyLimitMB	integer
enable	boolean
inboundThreshold	integer
key	string
mode	string
name	string
outboundThreshold	integer
paranoia	integer
remark	string
ruleSets	配列 of waf.RuleSet
skipBodyPaths	string
webdav	boolean

waf.RuleSet

フィールド	型
enable	boolean
param	string
remark	string
type	string

webhook.Config

フィールド	型
body	string
enable	boolean
headers	配列 of string
insecureSkipVerify	boolean
method	string
successContent	配列 of string
timeout	integer
url	string

webservice.BanInfo

フィールド	型
key	string
manual	boolean
permanent	boolean
reason	string
source	string
until	時刻 (RFC 3339)

webservice.CacheConfig

フィールド	型
enable	boolean
maxMb	integer
ttl	integer

webservice.ForwardAuth

フィールド	型
copyHeaders	配列 of string
loginUrl	string
url	string

webservice.HealthCheck

フィールド	型
enable	boolean
fails	integer
interval	integer
mode	string
passes	integer
path	string
timeout	integer

webservice.IPList

フィールド	型
count	integer
enable	boolean
key	string
name	string
refreshHours	integer
remark	string
updatedAt	時刻 (RFC 3339)
url	string

webservice.Listener

フィールド	型
acceptProxyProtocol	boolean
default	webservice.Site
enable	boolean
http3	boolean
key	string
listenIp	string
minTls	string
name	string
network	string
port	integer
remark	string
sites	配列 of webservice.Site
tls	boolean

webservice.Location

フィールド	型
prefix	string
requestHeaders	配列 of string
targets	配列 of string

webservice.PathRule

フィールド	型
auth	string
ipList	配列 of string
ipMode	string
ipSets	配列 of string
prefix	string

webservice.Point

フィールド	型
bytes	integer
requests	integer
s4xx	integer
s5xx	integer
t	integer

webservice.RateLimit

フィールド	型
burst	integer
enable	boolean
maxConns	integer
rate	number

webservice.Rewrite

フィールド	型
code	integer
pattern	string
redirect	boolean
to	string

webservice.ShareLink

フィールド	型
expiresAt	時刻 (RFC 3339)
key	string
maxUses	integer
name	string
pathPrefix	string
token	string

webservice.Site

フィールド	型
accessLog	boolean
authOptional	boolean
basicAuth	boolean
cache	webservice.CacheConfig
cleanUrls	boolean
compress	boolean
contentType	string
cors	boolean
countries	配列 of string
countryMode	string
disableKeepAlives	boolean
domains	配列 of string
enable	boolean
forwardAuth	webservice.ForwardAuth
forwardedHeaders	boolean
health	webservice.HealthCheck
insecureSkipVerify	boolean
ipList	配列 of string
ipMode	string
ipSets	配列 of string
keepPath	boolean
key	string
lbPolicy	string
listDir	boolean
locations	配列 of webservice.Location
name	string
notFoundPage	string
oauthUsers	配列 of string
rateLimit	webservice.RateLimit
redirectCode	integer
redirectTo	string
remark	string
requestHeaders	配列 of string
responseHeaders	配列 of string
rewrites	配列 of webservice.Rewrite
root	string
rules	配列 of webservice.PathRule
sendProxyProtocol	boolean
shareLinks	配列 of webservice.ShareLink
sharedUsers	boolean
statusCode	integer
targets	配列 of string
text	string
type	string
upstreamSniFromHost	boolean
useTargetHost	boolean
users	配列 of string
waf	string
webAuth	boolean

webservice.SiteStatsView

フィールド	型
bytesOut	integer
series	配列 of webservice.Point
status	マップ of integer
topCountries	配列 of webservice.TopItem
topIps	配列 of webservice.TopItem
upstreams	配列 of webservice.UpstreamStatus

webservice.TopItem

フィールド	型
count	integer
key	string

webservice.UpstreamStatus

フィールド	型
backup	boolean
conns	integer
healthy	boolean
url	string
weight	integer

webservice.banRequest

フィールド	型
key	string
seconds	integer

webservice.geoipDownload

フィールド	型
url	string

webservice.totpRequest

フィールド	型
name	string

webservice.totpResponse

フィールド	型
secret	string
url	string

webterminal.Connection

フィールド	型
enable	boolean
key	string
local	webterminal.LocalConfig
name	string
quickAccessDirs	配列 of string
remark	string
ssh	webterminal.SSHConfig
telnet	webterminal.TelnetConfig
type	string

webterminal.Credential

フィールド	型
authType	string
enable	boolean
key	string
keyFile	string
name	string
passphrase	string
password	string
privateKey	string
remark	string
username	string

webterminal.LocalConfig

フィールド	型
env	マップ of string
shell	string
workDir	string

webterminal.Proxy

フィールド	型
enabled	boolean
host	string
password	string
port	integer
type	string
username	string

webterminal.SSHConfig

フィールド	型
authType	string
credentialKey	string
host	string
hostKey	string
keepAlive	integer
keyFile	string
passphrase	string
password	string
port	integer
privateKey	string
proxy	webterminal.Proxy
timeout	integer
username	string
workDir	string

webterminal.TelnetConfig

フィールド	型
host	string
password	string
port	integer
proxy	webterminal.Proxy
timeout	integer
username	string

wol.Device

フィールド	型
broadcastIps	配列 of string
checkAddr	string
enable	boolean
key	string
macs	配列 of string
name	string
port	integer
remark	string
repeat	integer