Passer au contenu principal
GET
Obtenir le statut de mise à jour

Autorisations

Authorization
string
header
requis

L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé d’API administrateur (préfixée par mint_). Il s’agit d’une clé secrète utilisée côté serveur. Générez-en une depuis la page API keys de votre Dashboard.

Paramètres de chemin

statusId
string
requis

L’identifiant de statut de la mise à jour déclenchée.

Réponse

200 - application/json

Une réponse réussie

_id
string

L’identifiant de statut de la mise à jour déclenchée.

projectId
string

L’identifiant du projet de documentation.

createdAt
string

Une valeur ISODate correspondant à la date et à l’heure spécifiées en UTC

endedAt
string

Une valeur ISODate correspondant à la date et à l’heure spécifiées en UTC

status
enum<string>

Le statut de la mise à jour.

Options disponibles:
queued,
in_progress,
success,
failure
summary
string

Récapitulatif de l’état de la mise à jour

logs
string[]

Un tableau de logs.

subdomain
string

Le sous-domaine de la documentation en cours de mise à jour.

screenshot
string

Une capture d’écran de la documentation.

screenshotLight
string

Une capture d’écran de la doc.

screenshotDark
string

Une capture d’écran de la documentation en mode sombre.

author
object | null

L'auteur de la mise à jour.

commit
object

Les détails du commit

source
enum<string>

La source du déclencheur de mise à jour.

Options disponibles:
internal,
github-app-installation,
api,
github,
dashboard,
gitlab,
onboarding