管理エンドポイント
これらのエンドポイントを使用して、APIキー、フォームルール、アラートルール、およびその他の設定をプログラムで管理できます。すべての管理エンドポイントにはJWT認証が必要です。
Base URL: https://api.silentshield.io
APIキー
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | アカウントのすべてのAPIキーを一覧表示します。 |
POST | /api/v1/keys | 新しいAPIキーを作成します。 |
GET | /api/v1/keys/{id} | 特定のAPIキーの詳細を取得します。 |
PUT | /api/v1/keys/{id} | APIキーの設定を更新します。 |
DELETE | /api/v1/keys/{id} | APIキーを削除します。この操作は取り消せません。 |
POST | /api/v1/keys/{id}/rotate | APIキーをローテーションします。古いキーは即座に無効化されます。 |
フォームルール
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | キーの有効なフォームルールを読み取ります。このルートはウィジェット自身が呼び出します。フォームルールに関する唯一のエンドポイントです。 |
GET | /api/v1/keys/{id}/formrules/dryrun | 直近に検出されたフォームに対してルールを試験的に適用します(保存はしません)。 |
フォームルールはダッシュボードで管理します。API 経由の作成・変更・削除は意図的に用意していません。
アラートルール
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | APIキーのすべてのアラートルールを一覧表示します。 |
POST | /api/v1/keys/{id}/alerts | 新しいアラートルールを作成します。 |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | アラートルールを削除します。 |