Passer au contenu principal
GET
/
project
/
update-status
/
{statusId}
Obtenir le statut de mise à jour
curl --request GET \
  --url https://api.mintlify.com/v1/project/update-status/{statusId} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "projectId": "<string>",
  "createdAt": "<string>",
  "endedAt": "<string>",
  "status": "queued",
  "summary": "<string>",
  "logs": [
    "<string>"
  ],
  "subdomain": "<string>",
  "screenshot": "<string>",
  "screenshotLight": "<string>",
  "screenshotDark": "<string>",
  "author": "<string>",
  "commit": {
    "sha": "<string>",
    "ref": "<string>",
    "message": "<string>",
    "filesChanged": {
      "added": [
        "<string>"
      ],
      "modified": [
        "<string>"
      ],
      "removed": [
        "<string>"
      ]
    }
  },
  "source": "internal"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

statusId
string
required

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

Response

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
string

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