Pages de statut

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/status-pages

Exemple de requête: 

curl --location --request GET 'https://up.aubin.dev/api/v1/status-pages' \
--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 : name pour Nom. Par défaut : name.
monitor_id
facultatif integer
ID de moniteur.
sort_by
facultatif string
Trier par. Les valeurs possibles sont : id pour Date de création, name pour Nom. Par défaut : id.
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/status-pages/{id}

Exemple de requête: 

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

Point de terminaison API:

POST 
https://up.aubin.dev/api/v1/status-pages

Exemple de requête: 

curl --location --request POST 'https://up.aubin.dev/api/v1/status-pages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'slug={slug}'
Paramètre
Type
Description
name
requis string
Nom.
slug
requis string
Slug.
monitor_ids[]
facultatif array
IDs de moniteur
privacy
facultatif integer
Confidentialité. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Par défaut : 0.
password
facultatif string
Mot de passe. Ne fonctionne que si le champ privacy est défini sur 2.
domain
facultatif string
Domaine personnalisé.
logo
facultatif file
Logo.
favicon
facultatif file
Favicon.
remove_logo
facultatif boolean
Supprimer le logo.
remove_favicon
facultatif boolean
Supprimer le favicon.
website_url
facultatif string
URL du site web.
contact_url
facultatif string
URL de contact.
custom_css
facultatif string
CSS personnalisé.
custom_js
facultatif string
JS personnalisé.
meta_title
facultatif string
Méta-titre.
meta_description
facultatif string
Méta-description.
noindex
facultatif boolean
Exclure la page de statut des moteurs de recherche.
Mettre à jour

Point de terminaison API:

POST 
https://up.aubin.dev/api/v1/status-pages/{id}

Exemple de requête: 

curl --location --request POST 'https://up.aubin.dev/api/v1/status-pages/{id}' \
--header 'Authorization: Bearer {api_key}' \
--form '_method="PUT"'
Paramètre
Type
Description
_method
requis string
Doit être défini sur PUT.
name
facultatif string
Nom.
slug
facultatif string
Slug.
monitor_ids[]
facultatif array
IDs de moniteur
privacy
facultatif integer
Confidentialité. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
password
facultatif string
Mot de passe. Ne fonctionne que si le champ privacy est défini sur 2.
domain
facultatif string
Domaine personnalisé.
logo
facultatif file
Logo.
favicon
facultatif file
Favicon.
remove_logo
facultatif boolean
Supprimer le logo.
remove_favicon
facultatif boolean
Supprimer le favicon.
website_url
facultatif string
URL du site web.
contact_url
facultatif string
URL de contact.
custom_css
facultatif string
CSS personnalisé.
custom_js
facultatif string
JS personnalisé.
meta_title
facultatif string
Méta-titre.
meta_description
facultatif string
Méta-description.
noindex
facultatif boolean
Exclure la page de statut des moteurs de recherche.
Supprimer

Point de terminaison API:

DELETE 
https://up.aubin.dev/api/v1/status-pages/{id}

Exemple de requête: 

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