Supprimer un domaine personnalisé

DELETE /v1/custom-domains/{custom_domain_id} · autorisation custom-domains:write

Supprime un domaine personnalisé : il passe à released, la connexion sur ce domaine cesse et le nom reste en quarantaine pendant 30 jours (aucun autre environnement ne peut l'ajouter). Le domaine principal et le domaine utilisé comme émetteur de l'environnement ne peuvent pas être supprimés ; définissez d'abord un autre domaine comme principal. Supprimer un domaine déjà libéré ne fait que répéter la libération dans le registre de la plateforme.

Requête

Champ Type Obligatoire Description
custom_domain_id string oui Identifiant du domaine personnalisé (cdom_…).
If-Match header oui Obligatoire. L'ETag du domaine ; 428 lorsqu'il est absent, 412 lorsqu'il ne correspond pas.

Aucun corps de requête.

Réponse

204 No Content.

Erreurs

HTTP code Quand
404 not_found Le domaine personnalisé n'existe pas ou appartient à un autre environnement.
409 custom_domain_in_use Le domaine est le domaine principal ou l'émetteur de l'environnement.
409 domain_in_use_by_rp_id Le domaine est le rpId des clés d'accès d'une connexion, ou le rpId précédent d'une migration de rpId en cours ; déplacez d'abord le rpId avec Modifier le rpId des clés d'accès.
412 precondition_failed If-Match ne correspond pas à la version actuelle du domaine.
428 precondition_required If-Match est absent.
503 service_unavailable Le registre de domaines de la plateforme ou les informations d'émetteur de l'environnement sont temporairement indisponibles.
401 unauthenticated L'identifiant est absent, invalide ou révoqué.
403 insufficient_permissions L'identifiant ne dispose pas de l'autorisation requise.
429 rate_limited La limite de débit a été dépassée ; réessayez après la période indiquée par Retry-After.

Exemple

curl -X DELETE https://api.eu.keenauth.com/v1/custom-domains/cdom_01j9xk3m7q8r2s4t6v8w0y2z4a \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "3"'