ウェブフックエンドポイントを削除する
DELETE /v1/webhook-endpoints/{endpoint_id} · 権限 webhook-endpoints:write · すべてのプラン
エンドポイントを削除します。保留中および再試行中の配信は同じトランザクションで取り消されます。配信履歴は 30 日間の保持期間中は残ります。If-Match は必須です。* を指定すると、保存されているバージョンに関係なく削除されます。
リクエスト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
endpoint_id |
path | はい | ウェブフックエンドポイント ID（whe_…）。 |
If-Match |
header | はい | エンドポイントの現在の ETag、または *。 |
レスポンス
204 No Content。
エラー
| HTTP | code | 発生条件 |
|---|---|---|
| 404 | not_found |
この環境に該当するエンドポイントがありません。 |
| 412 | precondition_failed |
If-Match が現在のバージョンと一致しません。 |
| 428 | precondition_required |
If-Match が指定されていません。 |
| 401 | unauthenticated |
認証情報が欠落しているか、無効または取り消されています。 |
| 403 | insufficient_permissions |
認証情報に webhook-endpoints:write 権限がありません。 |
| 503 | service_unavailable |
ウェブフックの管理機能は一時的に利用できません。Retry-After の期間を待ってから再試行してください。 |
例
curl -X DELETE https://api.eu.keenauth.com/v1/webhook-endpoints/whe_01k8a3m5q7t9v1w3x5y7z9b2c4 \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H 'If-Match: "3"'
CLI: keenauth webhook-endpoints delete whe_01k8a3m5q7t9v1w3x5y7z9b2c4 --if-match '"3"'