Saltar al contenido principal
GET
/
project
/
update-status
/
{statusId}
Obtener el estado de la actualización
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"
}

Autorizaciones

​
Authorization
string
header
requerido

El encabezado Authorization espera un token de tipo Bearer. Usa una clave de API de administrador (con el prefijo mint_). Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.

Parámetros de ruta

​
statusId
string
requerido

El identificador de estado de una actualización activada.

Respuesta

200 - application/json

Una respuesta correcta

​
_id
string

El ID de estado de la actualización que se activó.

​
projectId
string

El identificador del proyecto de documentación.

​
createdAt
string

Un ISODate con la fecha y la hora especificadas en UTC

​
endedAt
string

Un ISODate con la fecha y hora especificadas en UTC

​
status
enum<string>

El estado de la actualización.

Opciones disponibles:
queued,
in_progress,
success,
failure
​
summary
string

Resumen del estado de la actualización

​
logs
string[]

Una matriz de registros.

​
subdomain
string

El subdominio de la documentación que se está actualizando.

​
screenshot
string

Una captura de pantalla de la documentación.

​
screenshotLight
string

Una captura de pantalla de la documentación.

​
screenshotDark
string

Captura de pantalla de la documentación en modo oscuro.

​
author
string

El autor de la actualización.

​
commit
object

Detalles de la confirmación

​
source
enum<string>

Origen del disparador de la actualización.

Opciones disponibles:
internal,
github-app-installation,
api,
github,
dashboard