Obtenir le statut de déploiement

Récupérer le statut d’une mise à jour à partir de son identifiant de statut

GET /project/update-status/{statusId}

Obtenir le statut de mise à jour

cURL

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

200

{
  "_id": "<string>",
  "projectId": "<string>",
  "createdAt": "<string>",
  "endedAt": "<string>",
  "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>"
      ]
    }
  }
}

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.

Show child attributes

commit · object

Les détails du commit

Show child attributes

source · enum<string>

La source du déclencheur de mise à jour.

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