Lösche eine API
DELETE /v1/apis/{api_id}?confirm=true · Berechtigung apis:write
Soft-Löscht eine API. confirm=true und If-Match sind erforderlich. Anwendungsgenehmigungen für diese API und die Standard-API-Einstellung von Anwendungen, die darauf verweisen, werden in der gleichen Operation entfernt, der Identifier kann 90 Tage lang nicht wiederverwendet werden, und Aktualisierungssitzungen, die für diese Zielgruppe ausgestellt wurden, werden widerrufen. Die System-API kann nicht gelöscht werden.
Anfrage
| Parameter | In | Beschreibung |
|---|---|---|
api_id |
path | Die API-ID. |
confirm |
query | Muss true sein. |
If-Match |
header | Das ETag aus dem letzten Lesen (erforderlich). |
Antwort
204 No Content, kein Body.
Fehler
| HTTP | Code | Wann |
|---|---|---|
| 404 | not_found |
Keine solche API in dieser Umgebung. |
| 409 | conflict |
Die API ist die System-API. |
| 412 | precondition_failed |
If-Match stimmt nicht mit der aktuellen Version überein. |
| 422 | validation_failed |
confirm fehlt oder ist nicht true (/confirm). |
| 428 | precondition_required |
Der If-Match-Header fehlt. |
Beispiel
curl -X DELETE "https://api.eu.keenauth.com/v1/apis/api_01h455vb4pex5vsknk084sn02q?confirm=true" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H 'If-Match: "1"'