Se connecterCommencer gratuitement
Référence APILister les règles d'automatisation
GET/v1/rules

Lister les règles d'automatisation

Récupère toutes les règles d'automatisation configurées pour l'espace de travail courant, triées de la plus récente à la plus ancienne.

1 min de lectureTélécharger en PDF

Réponse exemple

{
  "data": [
    {
      "id": "8f3c2b10-4e1a-4d22-9a77-1b2c3d4e5f60",
      "name": "Notifier Slack à chaque transfert E2E",
      "created_at": "2026-05-20T14:02:11.000Z",
      "is_enabled": true,
      "action_type": "slack_notify",
      "description": "Poste un message dans #securite quand un transfert chiffré de bout en bout est créé.",
      "workspace_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "action_config": {
        "webhook_url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
      },
      "trigger_count": 37,
      "trigger_event": "transfer.e2e_created",
      "last_triggered_at": "2026-06-04T09:12:44.000Z",
      "trigger_conditions": {
        "encryption_mode": "e2e"
      }
    }
  ],
  "object": "list"
}
GET/v1/rulesListe les règles d'automatisation de l'espace de travail.

Renvoie l'ensemble des règles d'automatisation (rules engine) définies pour l'espace de travail authentifié. Chaque règle associe un évènement déclencheur (trigger_event) à une action (action_type) exécutée automatiquement lorsque l'évènement se produit, par exemple poster sur Slack à chaque transfert créé ou prolonger l'expiration d'un transfert. Les règles sont retournées dans une enveloppe de liste et triées par date de création décroissante (created_at du plus récent au plus ancien). Le périmètre est strictement limité à l'espace de travail de la clé API : aucune règle d'un autre espace n'est jamais exposée.

Authentification

Cet endpoint exige une clé API valide disposant du scope transfers:read. La requête doit présenter la clé dans l'en-tête Authorization. L'appel est soumis au quota de débit de type lecture de l'espace de travail (en-têtes X-RateLimit-* retournés).

Réponse

La réponse est un objet de liste contenant object (toujours "list") et data, un tableau de règles. Chaque règle expose : id, name, description, trigger_event, trigger_conditions (objet de filtres optionnels ou null), action_type, action_config (paramètres propres à l'action), is_enabled, last_triggered_at (date du dernier déclenchement ou null), trigger_count (nombre total de déclenchements), created_at et workspace_id.

ChampTypeDescription
objectstringToujours "list".
dataarrayTableau des règles de l'espace de travail (vide si aucune règle).
data[].iduuidIdentifiant unique de la règle.
data[].namestringNom de la règle.
data[].descriptionstring | nullDescription libre, ou null.
data[].trigger_eventstringÉvènement déclencheur (voir liste des évènements supportés en POST).
data[].trigger_conditionsobject | nullFiltres conditionnels appliqués au déclenchement, ou null.
data[].action_typestringType d'action exécutée.
data[].action_configobjectParamètres de configuration de l'action.
data[].is_enabledbooleanIndique si la règle est active.
data[].last_triggered_atstring | nullHorodatage ISO du dernier déclenchement, ou null.
data[].trigger_countintegerNombre cumulé de déclenchements.
data[].created_atstringHorodatage ISO de création.
data[].workspace_iduuidIdentifiant de l'espace de travail propriétaire.

Erreurs

CodeQuandRésolution
missing_api_keyAucune clé API fournie dans l'en-tête Authorization.Ajoutez votre clé API à la requête.
invalid_api_keyLa clé API est inconnue ou malformée.Vérifiez la clé utilisée.
scope_missingLa clé ne possède pas le scope transfers:read.Émettez une clé incluant transfers:read.
rate_limitedQuota de débit lecture dépassé pour l'espace de travail.Patientez selon l'en-tête Retry-After, puis réessayez.
internal_errorErreur lors de la lecture en base de données.Réessayez ; si le problème persiste, contactez le support avec le request_id.

Voir aussi