Listar implantações - Square Cloud

GET

apps

{app_id}

deployments

Listar implantações

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

import requests

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

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', 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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/deployments")
  .header("Authorization", "<authorization>")
  .asString();

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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Use este endpoint para inspecionar o que aconteceu durante as implantações recentes: cada array interno captura o ciclo de vida de uma tentativa de implantação, passando pelos estados pending, clone (apenas implantações via Git), commit, restarting e success. Cada evento carrega um campo source derivado: git quando a implantação veio de um webhook ou push via GitHub App, upload quando veio de um upload de zip ou de uma chamada a Enviar commit da aplicação. O registro de implantações vem de um cache de curta duração no cluster, então ele reflete apenas a atividade mais recente da aplicação e retorna um array vazio quando não há mais nada registrado. Para verificar a integração Git configurada atualmente em vez das tentativas de implantação anteriores, veja Obter implantação atual.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

Resposta

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

array

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID da implantação.

string

O estado da implantação. Pode ser pending, clone, success ou error.

string

A data em que a implantação foi criada.

{
    "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"
	    }
	]
    ],
}

Obter implantação atualObter as informações de implantação atual de uma aplicação.

Listar implantações

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

import requests

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

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', 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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/deployments")
  .header("Authorization", "<authorization>")
  .asString();

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"
	    }
	]
    ],
}

​Parâmetros

​Resposta

Parâmetros

Resposta