Skip to content

API Analyses programmées

Maintenu par : Aether365 Team Public : Développeurs Périmètre : Endpoints de l'API Scheduled Scans - création et gestion des calendriers d'analyse

Les analyses programmées définissent des tâches d'analyse récurrentes. Chaque analyse programmée définit un déclencheur récurrent qui s'exécute à l'intervalle configuré.

Lister les analyses programmées

Renvoie toutes les analyses programmées pour le tenant authentifié, y compris l'analyse automatique du plan.

GET /tenants/me/scheduled-scans

Exemple de requête

bash
curl https://api.aether365.io/tenants/me/scheduled-scans \
  -H "Authorization: Bearer <token>"

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "plan",
      "isPlanSchedule": true,
      "name": "Automatic plan scan",
      "frequency": "weekly",
      "hour": 0,
      "minute": 0,
      "dayOfWeek": 0,
      "dayOfMonth": 1,
      "timezone": "UTC",
      "enabled": true,
      "scanType": "compliance",
      "lastTriggeredAt": "2026-04-07T00:00:00Z"
    },
    {
      "id": "sched_abc123",
      "isPlanSchedule": false,
      "name": "Weekly exposure scan",
      "frequency": "weekly",
      "hour": 6,
      "minute": 0,
      "dayOfWeek": 3,
      "dayOfMonth": null,
      "timezone": "Europe/London",
      "enabled": true,
      "scanType": "exposure",
      "lastTriggeredAt": "2026-04-09T06:00:00Z"
    }
  ]
}

Champs de la réponse

ChampTypeDescription
idstringIdentifiant du calendrier ("plan" pour l'analyse automatique du plan)
isPlanSchedulebooleantrue s'il s'agit de l'analyse automatique du plan
namestringNom d'affichage
frequencystringdaily, weekly ou monthly
hourintegerHeure de déclenchement (0-23)
minuteintegerMinute de déclenchement (0-59)
dayOfWeekintegerJour de la semaine pour les calendriers hebdomadaires (0=Lun, 6=Dim)
dayOfMonthintegerJour du mois pour les calendriers mensuels (1-31)
timezonestringChaîne de fuseau horaire IANA
enabledbooleanIndique si le calendrier est actif
scanTypestringcompliance ou exposure
lastTriggeredAtstring ou nullHorodatage ISO 8601 du dernier déclenchement

Créer une analyse programmée

Crée une nouvelle analyse programmée.

POST /tenants/me/scheduled-scans

Corps de la requête

json
{
  "name": "Monthly exposure scan",
  "frequency": "monthly",
  "hour": 3,
  "minute": 0,
  "dayOfMonth": 1,
  "timezone": "UTC",
  "scanType": "exposure",
  "enabled": true
}
ChampTypeRequisDescription
namestringOuiNom d'affichage
frequencystringOuidaily, weekly ou monthly
hourintegerOui0-23
minuteintegerOui0-59
dayOfWeekintegerPour weekly0=Lun, 6=Dim
dayOfMonthintegerPour monthly1-31
timezonestringOuiFuseau horaire IANA (ex. UTC, Europe/Berlin)
scanTypestringOuicompliance ou exposure
enabledbooleanNonPar défaut true

Exemple de requête

bash
curl -X POST https://api.aether365.io/tenants/me/scheduled-scans \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Monthly exposure scan",
    "frequency": "monthly",
    "hour": 3,
    "minute": 0,
    "dayOfMonth": 1,
    "timezone": "UTC",
    "scanType": "exposure",
    "enabled": true
  }'

Erreurs

CodeHTTPDescription
SCAN_PLAN_LIMIT_REACHED429Limite de calendriers personnalisés atteinte pour votre plan
VALIDATION_ERROR400Champs manquants ou invalides

Mettre à jour une analyse programmée

Met à jour une analyse programmée existante. Seuls les champs inclus sont mis à jour.

PATCH /tenants/me/scheduled-scans/{scheduledScanId}

Exemple : Suspendre un calendrier

bash
curl -X PATCH https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Exemple : Modifier l'heure

bash
curl -X PATCH https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"hour": 8}'

Supprimer une analyse programmée

Supprime définitivement une analyse programmée et son calendrier sous-jacent.

DELETE /tenants/me/scheduled-scans/{scheduledScanId}

WARNING

L'analyse automatique du plan (id: "plan") ne peut pas être supprimée via l'API.

Exemple de requête

bash
curl -X DELETE https://api.aether365.io/tenants/me/scheduled-scans/sched_abc123 \
  -H "Authorization: Bearer <token>"

Exemple de réponse

json
{
  "success": true,
  "data": null
}
Cette page vous a-t-elle été utile ?