Eliminare un'API

DELETE /v1/apis/{api_id}?confirm=true · permesso apis:write

Elimina in modo soft un'API. confirm=true e If-Match sono obbligatori. I grant dell'applicazione per questa API e l'impostazione API predefinita dell'applicazione che punta a essa vengono rimossi nella stessa operazione, l'identificatore non può essere riutilizzato per 90 giorni e le sessioni di refresh emesse per questo audience vengono revocate. L'API di sistema non può essere eliminata.

Richiesta

Parametro In Descrizione
api_id path L'ID dell'API.
confirm query Deve essere true.
If-Match header L'ETag dall'ultima lettura (obbligatorio).

Risposta

204 No Content, nessun body.

Errori

HTTP code Quando
404 not_found Nessuna API in questo ambiente.
409 conflict L'API è l'API di sistema.
412 precondition_failed If-Match non corrisponde alla versione attuale.
422 validation_failed confirm è mancante o non è true (/confirm).
428 precondition_required If-Match è mancante.

Esempio

curl -X DELETE "https://api.eu.keenauth.com/v1/apis/api_01h455vb4pex5vsknk084sn02q?confirm=true" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "1"'