Obtener el estado de la implementación
Obtén el estado de una actualización mediante el ID de estado
curl --request GET \
--url https://api.mintlify.com/v1/project/update-status/{statusId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mintlify.com/v1/project/update-status/{statusId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mintlify.com/v1/project/update-status/{statusId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintlify.com/v1/project/update-status/{statusId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mintlify.com/v1/project/update-status/{statusId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/project/update-status/{statusId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintlify.com/v1/project/update-status/{statusId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"projectId": "<string>",
"createdAt": "<string>",
"endedAt": "<string>",
"status": "queued",
"summary": "<string>",
"logs": [
"<string>"
],
"subdomain": "<string>",
"screenshot": "<string>",
"screenshotLight": "<string>",
"screenshotDark": "<string>",
"author": {
"name": "<string>",
"avatarUrl": "<string>",
"githubUserId": 123
},
"commit": {
"sha": "<string>",
"ref": "<string>",
"message": "<string>",
"filesChanged": {
"added": [
"<string>"
],
"modified": [
"<string>"
],
"removed": [
"<string>"
]
}
},
"source": "internal"
}Autorizaciones
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
El identificador de estado de una actualización activada.
Respuesta
Una respuesta correcta
El ID de estado de la actualización que se activó.
El identificador del proyecto de documentación.
Un ISODate con la fecha y la hora especificadas en UTC
Un ISODate con la fecha y hora especificadas en UTC
El estado de la actualización.
queued, in_progress, success, failure Resumen del estado de la actualización
Una matriz de registros.
El subdominio de la documentación que se está actualizando.
Una captura de pantalla de la documentación.
Una captura de pantalla de la documentación.
Captura de pantalla de la documentación en modo oscuro.
El autor de la actualización.
Show child attributes
Show child attributes
Detalles de la confirmación
Show child attributes
Show child attributes
Origen del disparador de la actualización.
internal, github-app-installation, api, github, dashboard, gitlab, onboarding ¿Esta página le ayudó?
curl --request GET \
--url https://api.mintlify.com/v1/project/update-status/{statusId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mintlify.com/v1/project/update-status/{statusId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mintlify.com/v1/project/update-status/{statusId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintlify.com/v1/project/update-status/{statusId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mintlify.com/v1/project/update-status/{statusId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/project/update-status/{statusId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintlify.com/v1/project/update-status/{statusId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"_id": "<string>",
"projectId": "<string>",
"createdAt": "<string>",
"endedAt": "<string>",
"status": "queued",
"summary": "<string>",
"logs": [
"<string>"
],
"subdomain": "<string>",
"screenshot": "<string>",
"screenshotLight": "<string>",
"screenshotDark": "<string>",
"author": {
"name": "<string>",
"avatarUrl": "<string>",
"githubUserId": 123
},
"commit": {
"sha": "<string>",
"ref": "<string>",
"message": "<string>",
"filesChanged": {
"added": [
"<string>"
],
"modified": [
"<string>"
],
"removed": [
"<string>"
]
}
},
"source": "internal"
}