Obtenir le statut de déploiement
Récupérer le statut d’une mise à jour à partir de son identifiant de statut
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"
}Autorisations
Paramètres de chemin
L’identifiant de statut de la mise à jour déclenchée.
Réponse
Une réponse réussie
L’identifiant de statut de la mise à jour déclenchée.
L’identifiant du projet de documentation.
Une valeur ISODate correspondant à la date et à l’heure spécifiées en UTC
Une valeur ISODate correspondant à la date et à l’heure spécifiées en UTC
Le statut de la mise à jour.
queued, in_progress, success, failure Récapitulatif de l’état de la mise à jour
Un tableau de logs.
Le sous-domaine de la documentation en cours de mise à jour.
Une capture d’écran de la documentation.
Une capture d’écran de la doc.
Une capture d’écran de la documentation en mode sombre.
L'auteur de la mise à jour.
Show child attributes
Show child attributes
Les détails du commit
Show child attributes
Show child attributes
La source du déclencheur de mise à jour.
internal, github-app-installation, api, github, dashboard, gitlab, onboarding Cette page vous a-t-elle été utile ?
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"
}