# Référence de l’API Moniteurs

Source: https://instatus.com/help/fr/api/monitors

- [Monitors](https://instatus.com/help/fr/api/monitors#get-monitors): Check the uptime of your websites, APIs, and services
- [Cron Monitors](https://instatus.com/help/fr/api/monitors#cron-monitors): Monitor your scheduled jobs via HTTP pings

## Valeurs possibles des champs

**Emplacement du moniteur**

| Valeur           | Description       |
| ---------------- | ----------------- |
| `US_EAST_1`      | Virginie du Nord  |
| `CA_CENTRAL_1`   | Canada (Montréal) |
| `EU_CENTRAL_1`   | Francfort         |
| `AP_NORTHEAST_1` | Tokyo             |

**Types d’alerte de moniteur**

| Valeur            | Description           |
| ----------------- | --------------------- |
| `INCIDENT`        | Alerte d’incident     |
| `EMAIL`           | Alerte par e-mail     |
| `SMS`             | Alerte SMS            |
| `SLACK`           | Alerte Slack          |
| `DISCORD`         | Alerte Discord        |
| `MICROSOFT_TEAMS` | Alerte Microsoft Teams |
| `PHONE_CALL`      | Alerte par appel téléphonique |
| `WEBHOOK`         | Alerte webhook        |
| `GOOGLE_CHAT`     | Alerte Google Chat    |
| `WHATSAPP`        | Alerte WhatsApp       |

**Statut du moniteur**

| Valeur     | Description                       |
| ---------- | --------------------------------- |
| `UP`       | Le moniteur fonctionne normalement |
| `DOWN`     | Le moniteur a échoué              |
| `DEGRADED` | Le moniteur rencontre des problèmes |
| `UNKNOWN`  | L’état du moniteur ne peut pas être déterminé |

## Récupérer les moniteurs

Ce point de terminaison permet de parcourir la liste de tous les moniteurs existants.

**Point de terminaison :**

```bash
GET /:page_id/monitors
```

**Paramètres de requête**

| Paramètre | Type     | Valeur par défaut | Description                                            |
| --------- | -------- | ------------- | ------------------------------------------------------ |
| `page`    | `number` | `1`           | Le numéro de page à récupérer.                         |
| `limit`   | `number` | `100`         | Le nombre de moniteurs par page.                       |
| `search`  | `string` | `null`        | Terme de recherche pour filtrer les résultats.         |
| `status`  | `enum`   | `null`        | Filtre de statut _('UP', 'DOWN', 'UNKNOWN', 'DEGRADED')_. |

**Exemple de requête**

```bash
GET /1/monitors?limit=3&page=2&status=DOWN
```

**Exemple de réponse**

```json
{
  "monitors": [{ "...": "monitor objects" }],
  "total": 10,
  "page": 3,
  "totalPages": 5,
  "limit": 2
}
```

## Créer un moniteur

**Point de terminaison :**

```bash
POST /monitors
```

**Exemple de requête**

```json
{
  "pageId": "page123",
  "url": "https://example.com",
  "httpMethod": "GET",
  "body": null,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer token"
  },
  "queryParams": {
    "search": "test",
    "limit": "10"
  },
  "basicAuth": {
    "username": "user",
    "password": "password"
  },
  "type": "HTTP",
  "assertions": [
    {
      "type": "STATUSCODE",
      "comparison": "EQUALS",
      "selector": null,
      "target": "200"
    }
  ],
  "alerts": ["alert-id-1", "alert-id-2"],
  "name": "Example Monitor",
  "locations": "US_EAST_1",
  "checksInterval": 300,
  "createComponent": true,
  "createMetric": true,
  "onFail": {
    "createIncident": true,
    "createOutageDuration": true,
    "publishIncident": true,
    "notifySubscribers": true
  },
  "onRecover": {
    "resolveIncident": true,
    "resolveOutageDuration": true,
    "publishIncident": true,
    "notifySubscribers": true
  }
}
```

**Exemple de réponse**

```json
{
  "monitor": {
    "pageId": "page123",
    "url": "https://example.com",
    "httpMethod": "GET",
    "body": null,
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "queryParams": {
      "search": "test",
      "limit": "10"
    },
    "basicAuth": {
      "username": "user",
      "password": "password"
    },
    "type": "HTTP",
    "assertions": [
      {
        "id": "assertion1",
        "type": "STATUSCODE",
        "comparison": "EQUALS",
        "selector": null,
        "target": "200"
      }
    ],
    "alerts": ["alert1", "alert2"],
    "name": "Example Monitor",
    "locations": "US_EAST_1",
    "checksInterval": 300,
    "createComponent": true,
    "createMetric": true,
    "onFail": {
      "createIncident": true,
      "createOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "onRecover": {
      "resolveIncident": true,
      "resolveOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z"
  },
  "message": "Monitor created successfully"
}
```

## Mettre à jour un moniteur

**Point de terminaison :**

```bash
PUT /monitors/:id
```

**Exemple de requête**

```json
{
  "url": "https://updated.com",
  "name": "Updated Monitor Name"
}
```

**Exemple de réponse**

```json
{
  "monitor": {
    "pageId": "page123",
    "url": "https://updated.com",
    "httpMethod": "GET",
    "body": null,
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "queryParams": {
      "search": "test",
      "limit": "10"
    },
    "basicAuth": {
      "username": "user",
      "password": "password"
    },
    "type": "HTTP",
    "assertions": [
      {
        "id": "assertion1",
        "type": "STATUSCODE",
        "comparison": "EQUALS",
        "selector": null,
        "value": "200"
      }
    ],
    "alerts": ["alert1", "alert2"],
    "name": "Updated Monitor Name",
    "locations": "US_EAST_1",
    "checksInterval": 300,
    "createComponent": true,
    "createMetric": true,
    "onFail": {
      "createIncident": true,
      "createOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "onRecover": {
      "resolveIncident": true,
      "resolveOutageDuration": true,
      "publishIncident": true,
      "notifySubscribers": true
    },
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z"
  },
  "message": "Monitor updated successfully"
}
```

## Supprimer un moniteur

**Point de terminaison :**

```bash
DELETE /monitors/:id
```

**Exemple de requête**

```bash
DELETE /monitors/monitor-id-1
```

**Exemple de réponse**

```json
{
  "message": "Monitor deleted successfully."
}
```

## Récupérer les journaux d’un moniteur

**Point de terminaison :**

```bash
GET /monitors/:id/logs
```

# Paramètres de requête

| Paramètre              | Type                                    | Valeur par défaut | Description                                                                             |
| ---------------------- | --------------------------------------- | --------------- | --------------------------------------------------------------------------------------- |
| `limit`                | `number`                                | 100             | Le nombre d’éléments par page. Ne peut pas dépasser 1000.                               |
| `page`                 | `number`                                | 1               | Le numéro de page à récupérer.                                                          |
| `monitorId`            | `string`                                | -               | L’ID du moniteur.                                                                       |
| `location`             | `string`                                | `null`          | L’emplacement du moniteur.                                                              |
| `createdAt`            | `string` \| `object` \| `number`        | `null`          | La date de création. Peut être une chaîne, un nombre ou un objet avec les champs `gte` et `lte`. |
| `isSuccessful`         | `boolean`                               | `null`          | Indique si la vérification a réussi.                                                    |
| `isSSLCheck`           | `boolean`                               | `null`          | Indique si la vérification est une vérification SSL.                                    |
| `httpStatusCode`       | `string`                                | `null`          | Le code de statut HTTP de la réponse.                                                   |
| `status`               | `('UP', 'DOWN', 'UNKNOWN', 'DEGRADED')` | `null`          | Le statut du moniteur.                                                                  |
| `dnsTime`              | `string` \| `number` \| `object`        | `null`          | Temps de résolution DNS.                                                                |
| `tcpTime`              | `string` \| `number` \| `object`        | `null`          | Temps d’établissement de la connexion TCP.                                              |
| `tlsTime`              | `string` \| `number` \| `object`        | `null`          | Temps de la poignée de main TLS.                                                        |
| `firstByteTime`        | `string` \| `number` \| `object`        | `null`          | Temps de réception du premier octet.                                                    |
| `downloadTime`         | `string` \| `number` \| `object`        | `null`          | Temps de téléchargement.                                                                |
| `responseTime`         | `string` \| `number` \| `object`        | `null`          | Temps de réponse total.                                                                 |
| `performanceTime`      | `string` \| `number` \| `object`        | `null`          | Temps de performance.                                                                   |
| `accessabilityScore`   | `string` \| `number` \| `object`        | `null`          | Score d’accessibilité.                                                                  |
| `seoScore`             | `string` \| `number` \| `object`        | `null`          | Score SEO.                                                                              |
| `bestPracticesScore`   | `string` \| `number` \| `object`        | `null`          | Score de bonnes pratiques.                                                              |
| `successfulAssertions` | `string` \| `number` \| `object`        | `null`          | Nombre d’assertions réussies.                                                           |
| `sort`                 | `string`                                | chronologiquement | Champ de tri.                                                                           |

**Exemple de requête**

```bash
GET /monitors/monitor-id-1/logs?limit=100&page=1
```

**Exemple de réponse**

```json
{
  "monitorLogs": [
    // {monitor log object},
    // {monitor log object 2}
  ],
  "total": 478,
  "page": 1,
  "totalPages": 5,
  "limit": 100
}
```

## Exécuter la vérification d’un moniteur par ID

**Point de terminaison :**

```bash
GET /monitors/:id/run
```

**Paramètres de requête**

| Paramètre      | Type                                                                              | Valeur par défaut | Description                                                       |
| -------------- | --------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------- |
| `location`     | `'US_EAST_1', 'EU_CENTRAL_1', 'AP_NORTHEAST_1', 'AP_SOUTHEAST_2', 'CA_CENTRAL_1'` | -             | L’emplacement du moniteur. Doit être l’une des valeurs indiquées. |
| `retry`        | `boolean`                                                                         | `false`       | Indique si l’opération doit être réessayée. Facultatif.           |
| `monitorLogId` | `string`                                                                          | `null`        | L’identifiant unique du journal de moniteur. Facultatif.          |

**Exemple de requête**

```bash
GET /monitors/monitor-id-1/run?monitorId=abc123&location=US_EAST_1&retry=true&monitorLogId=log456
```

**Exemple de réponse**

```json
{
  "status": "success",
  "message": "Monitor check run successfully."
}
```

## Créer une alerte de moniteur

**Point de terminaison :**

```bash
POST /monitor-alerts
```

**Exemple de requête**

```json
{
  "type": "EMAIL",
  "pageId": "page123",
  "recipient": "user@example.com",
  "recipientWorkspace": "workspace123",
  "whenFails": true,
  "whenRecovers": true,
  "whenDegrades": false,
  "whenSslExpires": true,
  "sslExpiresInDays": 30,
  "monitors": ["monitor1", "monitor2"],
  "metadata": "Additional information about the alert"
}
```

**Exemple de réponse**

```json
{
  "monitor": {
    "id": "alert123",
    "siteId": "site123",
    "type": "EMAIL",
    "recipient": "user@example.com",
    "whenFails": true,
    "whenRecovers": true,
    "whenDegrades": false,
    "whenSslExpires": true,
    "sslExpiresInDays": 30,
    "monitors": [{ "id": "monitor1" }, { "id": "monitor2" }],
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z",
    "metadata": "Additional information about the alert"
  },
  "message": "Monitor Alert created successfully"
}
```

## Mettre à jour une alerte de moniteur

**Point de terminaison :**

```bash
PUT /monitor-alerts/:id
```

**Exemple de requête**

```json
{
  "type": "EMAIL",
  "monitors": ["monitor-1-id", "monitor-2-id", "monitor-3-id"]
}
```

**Exemple de réponse**

```json
{
  "monitor": {
    "type": "EMAIL",
    "pageId": "page123",
    "recipient": "user@example.com",
    "recipientWorkspace": "workspace123",
    "whenFails": true,
    "whenRecovers": true,
    "whenDegrades": false,
    "whenSslExpires": true,
    "sslExpiresInDays": 30,
    "monitors": ["monitor-1-id", "monitor-2-id"],
    "metadata": "Additional information about the alert"
  },
  "message": "Monitor alert updated successfully."
}
```

## Récupérer les alertes de moniteur

**Point de terminaison :**

```bash
GET /:page_id/monitor-alerts
```

**Paramètres de requête**

| Paramètre | Type     | Valeur par défaut | Description                   |
| --------- | -------- | ------------- | ----------------------------- |
| `limit`   | `number` | 100           | Le nombre d’éléments par page. |
| `page`    | `number` | 1             | Le numéro de page à récupérer. |

**Exemple de requête**

```bash
GET /1/monitor-alerts?limit=2&page=3
```

**Exemple de réponse**

```json
{
  "monitorAlerts": [
    {...monitor alert objects}
  ],
  "total": 27,
  "page": 3,
  "totalPages": 14,
  "limit": 2
}
```

## Supprimer une alerte de moniteur

**Point de terminaison :**

```bash
DELETE /monitor-alerts/:id
```

**Exemple de requête**

```bash
DELETE /monitor-alerts/alert-id-1
```

**Exemple de réponse**

```json
{
  "message": "Monitor alert deleted successfully."
}
```

## Créer un groupe de moniteurs

**Point de terminaison :**

```bash
POST /monitors-groups
```

**Exemple de requête**

```json
{
  "pageId": "page123",
  "name": "Example Name",
  "childId": "child456"
}
```

**Exemple de réponse**

```json
{
  "monitor": {
    "id": "group123",
    "name": "Example Name",
    "siteId": "site123",
    "collapsed": false,
    "monitors": [{ "id": "monitor1" }, { "id": "monitor2" }],
    "groupId": "parentGroup123",
    "children": [
      { "id": "childGroup1", "name": "Child Group 1" },
      { "id": "childGroup2", "name": "Child Group 2" }
    ],
    "order": 1,
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z",
    "parents": ["parent1", "parent2"],
    "componentId": "component123"
  },
  "message": "Monitor group created successfully."
}
```

## Mettre à jour un groupe de moniteurs

**Point de terminaison :**

```bash
PUT /monitors-groups/:id
```

**Exemple de requête**

```json
{
  "name": "Updated Monitor Group Name"
}
```

**Exemple de réponse**

```json
{
  "monitor": {
    "id": "group123",
    "name": "Updated Monitor Group Name",
    "siteId": "site123",
    "collapsed": true,
    "monitors": [{ "id": "monitor1" }, { "id": "monitor2" }],
    "groupId": "parentGroup123",
    "children": [
      { "id": "childGroup1", "name": "Child Group 1" },
      { "id": "childGroup2", "name": "Child Group 2" }
    ],
    "order": 1,
    "createdAt": "2023-08-08T12:00:00Z",
    "updatedAt": "2023-08-08T12:00:00Z",
    "parents": ["parent1", "parent2"],
    "componentId": "component123"
  },
  "message": "Monitor group updated successfully."
}
```

## Supprimer un groupe de moniteurs

**Point de terminaison :**

```bash
DELETE /monitors-groups/:id
```

**Exemple de requête**

```bash
DELETE /monitors-groups/group-id-1
```

**Exemple de réponse**

```json
{
  "message": "Monitor group deleted successfully."
}
```

## Ajouter des moniteurs à un groupe

**Point de terminaison :**

```bash
POST /monitors-groups/:id/monitors
```

**Exemple de requête**

```json
{
  "monitors": ["monitor1", "monitor2", "monitor3"]
}
```

**Exemple de réponse**

```json
{
  "message": "Monitors added to the group successfully."
}
```

## Exécuter la vérification d’un groupe de moniteurs

**Point de terminaison :**

```bash
GET /monitors-groups/:id/run
```

**Paramètres de requête**

| Paramètre      | Type                                                                              | Valeur par défaut | Description                                                       |
| -------------- | --------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------------------- |
| `location`     | `'US_EAST_1', 'EU_CENTRAL_1', 'AP_NORTHEAST_1', 'AP_SOUTHEAST_2', 'CA_CENTRAL_1'` | -             | L’emplacement du moniteur. Doit être l’une des valeurs indiquées. |
| `retry`        | `boolean`                                                                         | `false`       | Indique si l’opération doit être réessayée. Facultatif.           |
| `monitorLogId` | `string`                                                                          | `null`        | L’identifiant unique du journal de moniteur. Facultatif.          |

**Exemple de requête**

```bash
GET /monitors-groups/group-id-1/run
```

**Exemple de réponse**

```json
{
  "result": "OK",
  "monitorLogId": "monitor-log-id-1"
}
```

## Moniteurs cron

Les moniteurs cron suivent les tâches planifiées via des pings HTTP. Pour la configuration produit et l’utilisation dans le tableau de bord, voir [Surveillance cron](https://instatus.com/help/fr/monitoring/cron).

### Valeurs possibles des champs

**Statut du moniteur cron**

| Valeur     | Description                       |
| ---------- | --------------------------------- |
| `UP`       | Le moniteur fonctionne normalement |
| `DOWN`     | Le moniteur a échoué              |
| `DEGRADED` | Le moniteur rencontre des problèmes |
| `UNKNOWN`  | L’état du moniteur ne peut pas être déterminé |

**État du moniteur cron**

| Valeur   | Description                          |
| -------- | ------------------------------------ |
| `ACTIVE` | Le moniteur est vérifié activement   |
| `PAUSED` | Les vérifications du moniteur sont en pause |
| `MUTED`  | Le moniteur est en sourdine (aucune notification) |

**Statut de journal de moniteur cron**

| Valeur    | Description                                      |
| --------- | ------------------------------------------------ |
| `SUCCESS` | La tâche s’est terminée avec succès              |
| `FAILURE` | La tâche a explicitement signalé un échec      |
| `MISSED`  | La tâche n’a pas envoyé de ping dans la fenêtre attendue |
| `LATE`    | La tâche a envoyé un ping après la période mais dans le délai de grâce |
| `STARTED` | La tâche a signalé son démarrage (mesure de la durée d’exécution) |

**Période et délai de grâce**

`period` et `grace` sont exprimés en **secondes**. `period` est la fréquence d’exécution attendue de la tâche ; `grace` est le temps supplémentaire accordé avant que le moniteur soit marqué comme indisponible.

### Récupérer les moniteurs cron

**Point de terminaison :**

```bash
GET /:page_id/monitors/cron
```

**Paramètres de requête**

| Paramètre | Type     | Valeur par défaut | Description                                            |
| --------- | -------- | ------------- | ------------------------------------------------------ |
| `limit`   | `number` | `100`         | Le nombre de moniteurs cron par page. Maximum 100.     |
| `page`    | `number` | `1`           | Le numéro de page.                                     |
| `search`  | `string` | `null`        | Terme de recherche pour filtrer les résultats par nom. |
| `status`  | `enum`   | `null`        | Filtre de statut _('UP', 'DOWN', 'UNKNOWN', 'DEGRADED')_. |

**Exemple de requête**

```bash
GET /page123/monitors/cron?limit=10&page=1&status=DOWN
```

**Exemple de réponse**

```json
{
  "cronMonitors": [
    {
      "id": "cron-abc123",
      "name": "Daily backup",
      "slug": "my-page-x7k2m9n4p1q8w3e5",
      "period": 86400,
      "grace": 3600,
      "status": "UP",
      "state": "ACTIVE",
      "siteId": "page123",
      "order": 1,
      "groupId": null,
      "componentId": "component-id-1",
      "onFailCreateIncident": true,
      "onFailCreateOutageDuration": false,
      "onFailPublishIncident": true,
      "onFailNotifySubscribers": true,
      "onRecoverResolveIncident": true,
      "onRecoverResolveOutageDuration": false,
      "onRecoverPublishIncident": true,
      "onRecoverNotifySubscribers": true,
      "createTemplateId": null,
      "resolveTemplateId": null,
      "createdAt": "2024-01-15T08:00:00.000Z",
      "updatedAt": "2024-01-15T08:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "totalPages": 1,
  "limit": 10
}
```

### Créer un moniteur cron

**Point de terminaison :**

```bash
POST /monitors/cron
```

**Exemple de requête**

```json
{
  "pageId": "page123",
  "name": "Daily backup",
  "period": 86400,
  "grace": 3600,
  "alerts": ["alert-id-1", "alert-id-2"],
  "createComponent": true,
  "onFail": {
    "createIncident": true,
    "createOutageDuration": false,
    "publishIncident": true,
    "notifySubscribers": true
  },
  "onRecover": {
    "resolveIncident": true,
    "resolveOutageDuration": false,
    "publishIncident": true,
    "notifySubscribers": true
  }
}
```

**Exemple de réponse**

```json
{
  "cronMonitor": {
    "id": "cron-abc123",
    "name": "Daily backup",
    "slug": "my-page-x7k2m9n4p1q8w3e5",
    "period": 86400,
    "grace": 3600,
    "status": "UP",
    "state": "ACTIVE",
    "siteId": "page123",
    "order": 1,
    "groupId": null,
    "componentId": "component-id-1",
    "onFailCreateIncident": true,
    "onFailCreateOutageDuration": false,
    "onFailPublishIncident": true,
    "onFailNotifySubscribers": true,
    "onRecoverResolveIncident": true,
    "onRecoverResolveOutageDuration": false,
    "onRecoverPublishIncident": true,
    "onRecoverNotifySubscribers": true,
    "createTemplateId": null,
    "resolveTemplateId": null,
    "createdAt": "2024-01-15T08:00:00.000Z",
    "updatedAt": "2024-01-15T08:00:00.000Z"
  },
  "message": "Cron monitor created successfully."
}
```

La réponse contient un `slug`. Utilisez-le pour construire les URL de ping de votre tâche. Le premier ping réussi planifie la vérification en arrière-plan.

### Mettre à jour un moniteur cron

**Point de terminaison :**

```bash
PUT /monitors/cron/:id
```

**Exemple de requête**

```json
{
  "name": "Daily backup (updated)",
  "period": 43200,
  "grace": 1800,
  "state": "PAUSED",
  "alerts": ["alert-id-1"],
  "onFail": {
    "notifySubscribers": false
  }
}
```

**Exemple de réponse**

```json
{
  "cronMonitor": {
    "id": "cron-abc123",
    "name": "Daily backup (updated)",
    "slug": "my-page-x7k2m9n4p1q8w3e5",
    "period": 43200,
    "grace": 1800,
    "status": "UP",
    "state": "PAUSED",
    "siteId": "page123",
    "order": 1,
    "groupId": null,
    "componentId": "component-id-1",
    "onFailCreateIncident": true,
    "onFailCreateOutageDuration": false,
    "onFailPublishIncident": true,
    "onFailNotifySubscribers": false,
    "onRecoverResolveIncident": true,
    "onRecoverResolveOutageDuration": false,
    "onRecoverPublishIncident": true,
    "onRecoverNotifySubscribers": true,
    "createTemplateId": null,
    "resolveTemplateId": null,
    "alerts": [
      {
        "id": "alert-id-1",
        "type": "EMAIL",
        "recipient": "ops@example.com"
      }
    ],
    "createdAt": "2024-01-15T08:00:00.000Z",
    "updatedAt": "2024-01-16T10:30:00.000Z"
  },
  "message": "Cron monitor updated successfully."
}
```

### Supprimer un moniteur cron

**Point de terminaison :**

```bash
DELETE /monitors/cron/:id
```

**Exemple de requête**

```bash
DELETE /monitors/cron/cron-abc123
```

**Exemple de réponse**

```json
{
  "cronMonitor": {
    "id": "cron-abc123",
    "name": "Daily backup",
    "slug": "my-page-x7k2m9n4p1q8w3e5",
    "period": 86400,
    "grace": 3600,
    "status": "UP",
    "state": "ACTIVE",
    "siteId": "page123",
    "order": 1,
    "groupId": null,
    "componentId": "component-id-1",
    "onFailCreateIncident": true,
    "onFailCreateOutageDuration": false,
    "onFailPublishIncident": true,
    "onFailNotifySubscribers": true,
    "onRecoverResolveIncident": true,
    "onRecoverResolveOutageDuration": false,
    "onRecoverPublishIncident": true,
    "onRecoverNotifySubscribers": true,
    "createTemplateId": null,
    "resolveTemplateId": null,
    "createdAt": "2024-01-15T08:00:00.000Z",
    "updatedAt": "2024-01-15T08:00:00.000Z"
  },
  "message": "Cron monitor deleted successfully."
}
```

### Récupérer les journaux d’un moniteur cron

**Point de terminaison :**

```bash
GET /monitors/cron/:id/logs
```

**Paramètres de requête**

| Paramètre    | Type     | Valeur par défaut | Description                                              |
| ------------ | -------- | ------------- | -------------------------------------------------------- |
| `limit`      | `number` | `100`         | Le nombre de journaux par page. Maximum 127.             |
| `page`       | `number` | `1`           | Le numéro de page. Maximum 1000.                         |
| `startDate`  | `string` | il y a 1 an   | Date de début ISO 8601 de la plage de journaux.          |
| `endDate`    | `string` | maintenant    | Date de fin ISO 8601 de la plage de journaux.            |
| `importance` | `enum`   | `null`        | Filtrer les journaux par importance _('all', 'important')_. |

**Exemple de requête**

```bash
GET /monitors/cron/cron-abc123/logs?limit=50&page=1&importance=important
```

**Exemple de réponse**

```json
{
  "logs": [
    {
      "id": "log-xyz789",
      "monitorId": "cron-abc123",
      "status": "SUCCESS",
      "requestType": "GET",
      "agent": "curl/8.4.0",
      "ipAddress": "203.0.113.10",
      "createdAt": "2024-01-16T06:00:00.000Z",
      "startedAt": "2024-01-16T05:59:58.000Z"
    }
  ],
  "page": 1
}
```

### Récupérer le résumé d’un moniteur cron

**Point de terminaison :**

```bash
GET /monitors/cron/:id/summary
```

**Exemple de requête**

```bash
GET /monitors/cron/cron-abc123/summary
```

**Exemple de réponse**

```json
{
  "summary": {
    "totalLogs": 120,
    "totalFailedLogs": 3,
    "availability": 97.5,
    "oneDayAvailability": 100,
    "previousDayAvailability": 100,
    "sevenDayAvailability": 98.2,
    "previousSevenDayAvailability": 96.1,
    "thirtyDayAvailability": 97.5,
    "previousThirtyDayAvailability": 95.8,
    "lastSuccess": "2024-01-16T06:00:00.000Z",
    "lastFailure": "2024-01-10T06:00:00.000Z",
    "lastStarted": null,
    "upSince": "2024-01-10T07:00:00.000Z",
    "downSince": null
  }
}
```

### Points de terminaison de ping

Ces points de terminaison ne nécessitent **pas** d’authentification. Le `slug` du moniteur fait office de secret.

Vous pouvez envoyer un ping via l’URL de base de l’API ou l’hôte cron dédié :

- **Succès :** `https://cron.instatus.com/{slug}` ou `GET` / `POST` / `HEAD` `/monitors/cron/{slug}`
- **Échec :** `https://cron.instatus.com/{slug}/fail` ou `GET` / `POST` / `HEAD` `/monitors/cron/{slug}/fail`
- **Début :** `https://cron.instatus.com/{slug}/start` ou `GET` / `POST` / `HEAD` `/monitors/cron/{slug}/start`

Envoyez un ping de succès chaque fois que votre tâche se termine à l’heure prévue. Envoyez un ping de début avant l’exécution puis un ping de succès ou d’échec à la fin pour enregistrer la durée d’exécution.

**Exemple de ping de succès**

```bash
curl https://cron.instatus.com/my-page-x7k2m9n4p1q8w3e5
```

**Exemple de réponse**

```json
{
  "id": "log-xyz789",
  "monitorId": "cron-abc123",
  "status": "SUCCESS",
  "requestType": "GET",
  "agent": "curl/8.4.0",
  "ipAddress": "203.0.113.10",
  "createdAt": "2024-01-16T06:00:00.000Z"
}
```

Si le slug est invalide, la réponse est :

```json
{
  "message": "Monitor not found"
}
```