Listar deploys

GET

apps

{app_id}

deployments

Listar deploys

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": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "pending", "date": "2026-05-28T21:47:33.608Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "clone", "date": "2026-05-28T21:47:34.019Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "commit", "date": "2026-05-28T21:47:36.240Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "restarting", "date": "2026-05-28T21:47:37.105Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "success", "date": "2026-05-28T21:47:41.872Z", "source": "git" }
        ]
    ]
}

string

obrigatório

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

Requer uma chave de API com o escopo apps:read. Use este endpoint para inspecionar o que aconteceu durante os deploys recentes: cada array interno captura o ciclo de vida de uma tentativa de deploy, passando pelos estados pending, clone, commit, restarting e success. Um deploy que falha termina em um evento error que carrega um code (por exemplo AUTHENTICATION_REQUIRED, INVALID_BRANCH ou CLONE_FAILED) e, às vezes, uma message com detalhes. Não existe um estado failed. Apenas deploys via Git, de um webhook ou de um push do GitHub App, são registradas, então o source de todo evento é git. Uploads de zip e chamadas a Enviar commit da aplicação não aparecem aqui. O registro de deploys 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 deploy anteriores, veja Obter o deploy atual.

Parâmetros

string

obrigatório

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

Resposta

string

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

array

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID do deploy.

string

O estado do deploy: pending, clone, commit, restarting, success ou error.

string

A data do evento.

string

Sempre git.

string

Apenas em eventos error: o motivo da falha do deploy, por exemplo AUTHENTICATION_REQUIRED, INVALID_BRANCH ou CLONE_FAILED.

string

Apenas em alguns eventos error: detalhes sobre a falha.

{
    "status": "success",
    "response": [
        [
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "pending", "date": "2026-05-28T21:47:33.608Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "clone", "date": "2026-05-28T21:47:34.019Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "commit", "date": "2026-05-28T21:47:36.240Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "restarting", "date": "2026-05-28T21:47:37.105Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "success", "date": "2026-05-28T21:47:41.872Z", "source": "git" }
        ]
    ]
}

Relacionados

CLI: squarecloud app deploy list
SDKs: api.apps.deploys.list() (JavaScript), client.apps.deploys.list() (Python), c.Apps.Deploys.List() (Go)

Listar deploys

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": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "pending", "date": "2026-05-28T21:47:33.608Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "clone", "date": "2026-05-28T21:47:34.019Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "commit", "date": "2026-05-28T21:47:36.240Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "restarting", "date": "2026-05-28T21:47:37.105Z", "source": "git" },
            { "id": "96b1c6931c20b1555e612d3c8cd0a7b36f0fd5c7", "state": "success", "date": "2026-05-28T21:47:41.872Z", "source": "git" }
        ]
    ]
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Parâmetros

Resposta

Relacionados

​Parâmetros

​Resposta

​Relacionados

Parâmetros

Resposta

Relacionados