Obtenir le déploiement actuel

GET

apps

{app_id}

deployments

current

Obtenir le déploiement actuel

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

import requests

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

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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/current")

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": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
    }
}

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Your-GitHub/Repository",
            "branch": "main"
        }
    }
}

string

requis

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

Cet endpoint indique comment l’application est actuellement configurée pour les déploiements basés sur Git : une liaison de dépôt via la GitHub App, une URL de webhook classique, ou les deux, selon la façon dont l’intégration a été mise en place. Utilisez-le pour vérifier le dépôt et la branche suivis avant de diagnostiquer un problème de déploiement, ou pour confirmer si un webhook doit encore être généré. La réponse est mise en cache pendant 5 minutes par propriétaire et par application : les modifications effectuées via Configurer un webhook GitHub peuvent donc mettre quelques minutes à apparaître ici. Sur les applications partagées en workspace, l’appelant doit avoir le rôle Manager ou Administrator, ou en être propriétaire. Pour consulter l’historique des déploiements plutôt que la configuration actuelle, utilisez Lister les déploiements.

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.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’URL du webhook pour l’application.

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
    }
}

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Your-GitHub/Repository",
            "branch": "main"
        }
    }
}

Configurer un webhook GitHubIntégrez Square Cloud aux webhooks GitHub.

Obtenir le déploiement actuel

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

import requests

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

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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/current")

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": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/69ce71f11974f2cc21d47cd0a8bcbafdaacbc3c9924b23ca40e0e2032705f6391eb89b40983338e0f2415e9331d602ccc"
    }
}

{
    "status": "success",
    "response": {
        "app": {
            "id": "00000000",
            "name": "Your-GitHub/Repository",
            "branch": "main"
        }
    }
}

​Paramètres

​Réponse

Paramètres

Réponse