Incidents

Notes
Niveau expert
La clé API doit être envoyée comme jeton Bearer dans l'en-tête Authorization de la requête. Obtenir votre clé API.
Liste

Point de terminaison API:

GET 
https://up.aubin.dev/api/v1/incidents

Exemple de requête: 

curl --location --request GET 'https://up.aubin.dev/api/v1/incidents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
La requête de recherche.
search_by
facultatif string
Rechercher par. Les valeurs possibles sont : monitor pour Monitor, cause pour Cause. Par défaut : url.
monitor_id
facultatif string
ID de moniteur.
status
facultatif string
Statut. Les valeurs possibles sont : unresolved pour Non résolu, acknowledged pour Acquitté, resolved pour Résolu.
sort_by
facultatif string
Trier par. Les valeurs possibles sont : started_at pour Date de début, ended_at pour Date de fin. Par défaut : ended_at.
sort
facultatif string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. Par défaut : desc.
per_page
facultatif integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Par défaut : 25.
Afficher

Point de terminaison API:

GET 
https://up.aubin.dev/api/v1/incidents/{id}

Exemple de requête: 

curl --location --request GET 'https://up.aubin.dev/api/v1/incidents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Stocker

Point de terminaison API:

POST 
https://up.aubin.dev/api/v1/incidents

Exemple de requête: 

curl --location --request POST 'https://up.aubin.dev/api/v1/incidents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'monitor_id={monitor_id}' \
--data-urlencode 'started_at={started_at}'
Paramètre
Type
Description
monitor_id
requis integer
ID de moniteur.
started_at
requis string
Commencé à la date au format Y-m-dTH:i:s.
acknowledged_at
facultatif string
Acquitté à la date au format Y-m-dTH:i:s.
ended_at
facultatif string
Terminé à la date au format Y-m-dTH:i:s.
cause
facultatif string
Cause.
comment
facultatif string
Commentaire.
Mettre à jour

Point de terminaison API:

PUT PATCH 
https://up.aubin.dev/api/v1/incidents/{id}

Exemple de requête: 

curl --location --request PUT 'https://up.aubin.dev/api/v1/incidents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
acknowledged_at
facultatif string
Acquitté à la date au format Y-m-dTH:i:s.
ended_at
facultatif string
Terminé à la date au format Y-m-dTH:i:s.
cause
facultatif string
Cause.
comment
facultatif string
Commentaire.
Supprimer

Point de terminaison API:

DELETE 
https://up.aubin.dev/api/v1/incidents/{id}

Exemple de requête: 

curl --location --request DELETE 'https://up.aubin.dev/api/v1/incidents/{id}' \
--header 'Authorization: Bearer {api_key}'