APIを削除する
DELETE /v1/apis/{api_id}?confirm=true · 権限 apis:write
APIをソフト削除します。confirm=trueとIf-Matchが必須です。このAPIのアプリケーショングラントと、それを指すアプリケーションのデフォルトAPI設定は同じ操作で削除され、識別子は90日間再利用できず、このオーディエンス向けに発行されたリフレッシュセッションは取り消されます。システムAPIは削除できません。
リクエスト
| パラメータ | 入力 | 説明 |
|---|---|---|
api_id |
path | APIのID。 |
confirm |
query | trueである必要があります。 |
If-Match |
header | 最後の読み取り時のETag（必須）。 |
レスポンス
204 No Content、ボディなし。
エラー
| HTTP | code | 情況 |
|---|---|---|
| 404 | not_found |
この環境にそのようなAPIはありません。 |
| 409 | conflict |
APIはシステムAPIです。 |
| 412 | precondition_failed |
If-Matchが現在のバージョンと一致しません。 |
| 422 | validation_failed |
confirmが欠落しているかtrueではありません（/confirm）。 |
| 428 | precondition_required |
If-Matchが欠落しています。 |
例
curl -X DELETE "https://api.eu.keenauth.com/v1/apis/api_01h455vb4pex5vsknk084sn02q?confirm=true" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H 'If-Match: "1"'