管理エンドポイント

これらのエンドポイントを使用して、APIキー、フォームルール、アラートルール、およびその他の設定をプログラムで管理できます。すべての管理エンドポイントにはJWT認証が必要です。

Base URL: https://api.silentshield.io

APIキー

MethodPathDescription
GET/api/v1/keysアカウントのすべてのAPIキーを一覧表示します。
POST/api/v1/keys新しいAPIキーを作成します。
GET/api/v1/keys/:id特定のAPIキーの詳細を取得します。
PUT/api/v1/keys/:idAPIキーの設定を更新します。
DELETE/api/v1/keys/:idAPIキーを削除します。この操作は取り消せません。
POST/api/v1/keys/:id/rotateAPIキーをローテーションします。古いキーは即座に無効化されます。

フォームルール

MethodPathDescription
GET/api/v1/keys/:keyId/form-rulesAPIキーのすべてのフォームルールを一覧表示します。
POST/api/v1/keys/:keyId/form-rules新しいフォームルールを作成します。
PUT/api/v1/keys/:keyId/form-rules/:idフォームルールを更新します。
DELETE/api/v1/keys/:keyId/form-rules/:idフォームルールを削除します。

アラートルール

MethodPathDescription
GET/api/v1/keys/:keyId/alert-rulesAPIキーのすべてのアラートルールを一覧表示します。
POST/api/v1/keys/:keyId/alert-rules新しいアラートルールを作成します。
PUT/api/v1/keys/:keyId/alert-rules/:idアラートルールを更新します。
DELETE/api/v1/keys/:keyId/alert-rules/:idアラートルールを削除します。