Lister les déploiements

GET

apps

{app_id}

deployments

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deployments \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deployments', 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.squarecloud.app/v2/apps/{app_id}/deployments",
  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: <authorization>"
  ],
]);

$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.squarecloud.app/v2/apps/{app_id}/deployments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deployments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": [
        [
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "pending",
			    "date": "2023-10-16T20:27:20.513Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "clone",
			    "date": "2023-10-16T20:27:20.536Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "success",
			    "date": "2023-10-16T20:27:21.422Z"
		    }
	    ]
    ],
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Utilisez cet endpoint pour examiner ce qui s’est passé lors des déploiements récents : chaque tableau imbriqué capture le cycle de vie d’une tentative de déploiement, passant par les états pending, clone (déploiements Git uniquement), commit, restarting et success. Chaque événement porte un champ source dérivé : git lorsque le déploiement provient d’un webhook ou d’un push via la GitHub App, upload lorsqu’il provient d’un envoi de zip ou d’un appel à Commiter une application. Le journal de déploiement provient d’un cache de cluster de courte durée : il ne reflète donc que l’activité la plus récente de l’application et renvoie un tableau vide une fois qu’il n’y a plus rien d’enregistré. Pour vérifier l’intégration Git actuellement configurée plutôt que les tentatives de déploiement passées, consultez Obtenir le déploiement actuel.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

array

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’ID du déploiement.

string

L’état du déploiement. Peut être pending, clone, success ou error.

string

La date de création du déploiement.

{
    "status": "success",
    "response": [
        [
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "pending",
			    "date": "2023-10-16T20:27:20.513Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "clone",
			    "date": "2023-10-16T20:27:20.536Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "success",
			    "date": "2023-10-16T20:27:21.422Z"
		    }
	    ]
    ],
}

Obtenir le déploiement actuelObtenez les informations sur le déploiement actuel d'une application.

Lister les déploiements

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deployments \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deployments', 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.squarecloud.app/v2/apps/{app_id}/deployments",
  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: <authorization>"
  ],
]);

$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.squarecloud.app/v2/apps/{app_id}/deployments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deployments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": [
        [
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "pending",
			    "date": "2023-10-16T20:27:20.513Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "clone",
			    "date": "2023-10-16T20:27:20.536Z"
		    },
		    {
			    "id": "git-393caedd68f5e5b771f6a027",
			    "state": "success",
			    "date": "2023-10-16T20:27:21.422Z"
		    }
	    ]
    ],
}

​Paramètres

​Réponse

Paramètres

Réponse