Référence APICréer une alerte
POST/v1/alerts

Créer une alerte

Crée une règle d'alerte.

1 min de lectureTélécharger en PDF

Requête exemple

{
"name": "Alerte téléchargement rapide",
"is_active": true,
"action_type": "slack",
"action_value": {
"webhook_url": "https://hooks.slack.com/services/..."
},
"condition_type": "download_rate",
"condition_value": {
"count": 10,
"period_minutes": 5
}
}

Réponse exemple

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Alerte téléchargement rapide",
"is_active": true,
"created_at": "2026-06-05T12:00:00Z",
"action_type": "slack",
"condition_type": "download_rate",
"condition_value": {
"count": 10,
"period_minutes": 5
}
}

Crée une règle d'alerte déclenchée par un événement (nombre/débit de téléchargements, géo inattendue, mots de passe échoués, expiration proche) et une action.

Authentification

Requiert une clé API avec le scope alerts:manage.

Corps de la requête

ChampTypeRequisDescription
namestringOuiNom de la règle.
condition_typestringOuidownload_count, download_rate, failed_password, geo_unexpected, expiration_soon.
action_typestringNonemail, slack, discord ou webhook (défaut email).
condition_valueobjectNonParamètres de la condition (ex. {"threshold":50}).
action_valueobjectNonParamètres de l'action.
is_activebooleanNonActive la règle (défaut true).

Codes de statut

  • 201 Alerte créée.
  • 400 Validation.
  • 403 Scope insuffisant.