Supprimer une API
DELETE /v1/apis/{api_id}?confirm=true · permission apis:write
Supprime temporairement une API. confirm=true et If-Match sont obligatoires. Les droits d'accès (grants) des applications pour cette API et le paramètre API par défaut des applications qui la pointent sont supprimés dans la même opération, l'identifiant ne peut pas être réutilisé pendant 90 jours, et les sessions de rafraîchissement émises pour cette audience sont révoquées. L'API système ne peut pas être supprimée.
Demande
| Paramètre | Dans | Description |
|---|---|---|
api_id |
path | L'identifiant de l'API. |
confirm |
query | Doit être true. |
If-Match |
header | L'ETag de la dernière lecture (obligatoire). |
Réponse
204 No Content, sans corps.
Erreurs
| HTTP | code | Quand |
|---|---|---|
| 404 | not_found |
Aucune API avec cet identifiant dans cet environnement. |
| 409 | conflict |
L'API est l'API système. |
| 412 | precondition_failed |
If-Match ne correspond pas à la version actuelle. |
| 422 | validation_failed |
confirm manque ou n'est pas true (/confirm). |
| 428 | precondition_required |
If-Match manque. |
Exemple
curl -X DELETE "https://api.eu.keenauth.com/v1/apis/api_01h455vb4pex5vsknk084sn02q?confirm=true" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H 'If-Match: "1"'