Référence APISupprimer une règle d'automatisation
DELETE/v1/rules/{id}

Supprimer une règle d'automatisation

Supprime définitivement une règle d'automatisation et, en cascade, son historique d'exécutions.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"id": "a3f1c8e2-7b94-4d51-9f2a-1c6e8d0b4f73",
"object": "rule",
"deleted": true
}
DELETE/v1/rules/{id}Supprime définitivement une règle d'automatisation.

Supprime définitivement une règle d'automatisation de l'espace de travail. La suppression est irréversible et entraîne en cascade la suppression de l'historique d'exécutions associé à la règle. La règle est résolue par son id et le workspace_id du jeton : une règle d'un autre espace de travail renvoie 404.

Authentification

Cette requête nécessite une clé API valide dont le jeton porte le scope transfers:manage. Sans ce scope, la requête renvoie 403 scope_missing.

Paramètres de requête

ParamètreTypeEmplacementDescription
idstring (UUID)CheminIdentifiant de la règle à supprimer. Doit appartenir à l'espace de travail du jeton.

Réponse

Retourne un accusé de suppression contenant id (l'identifiant supprimé), object valant "rule", et deleted valant true. Aucun contenu de la règle n'est renvoyé.

ChampTypeDescription
idstringIdentifiant de la règle supprimée.
objectstringToujours "rule".
deletedbooleanToujours true en cas de succès.

Erreurs

CodeQuandRésolution
401 invalid_api_keyClé API absente, invalide, expirée ou révoquée.Vérifiez l'en-tête Authorization.
403 scope_missingLe jeton ne porte pas le scope transfers:manage.Générez une clé incluant transfers:manage.
404 not_foundAucune règle avec cet id dans l'espace de travail (déjà supprimée ou inexistante).Vérifiez l'identifiant ; une suppression déjà effectuée renvoie 404.
429 rate_limitedQuota de requêtes d'écriture dépassé.Patientez selon l'en-tête Retry-After.
500 internal_errorErreur interne lors de la suppression.Réessayez ; contactez le support avec le request_id si persistant.

Voir aussi