List Deployments

GET

apps

{app_id}

deployments

List 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": "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

required

The API key for your account. You can find this in your account settings.

Requires an API key with the apps:read scope. Use this endpoint to inspect what happened during recent deploys: each inner array captures one deploy attempt’s lifecycle, moving through the pending, clone, commit, restarting and success states. A deploy that fails ends in an error event that carries a code (for example AUTHENTICATION_REQUIRED, INVALID_BRANCH or CLONE_FAILED) and, sometimes, a message with details. There is no failed state. Only Git deploys, from a webhook or a GitHub App push, are recorded, so every event’s source is git. Zip uploads and Commit Application calls don’t appear here. The deploy log comes from a short-lived cluster cache, so it only reflects the application’s most recent activity and returns an empty array once nothing remains recorded. To check the currently configured Git integration instead of past deploy attempts, see Get Current Deployment.

Parameters

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

Response

string

Indicates whether the call was successful: success if it was, error if not.

array

The contents of the response.

Show Toggle object

string

The ID of the deploy.

string

The state of the deploy: pending, clone, commit, restarting, success or error.

string

The date of the event.

string

Always git.

string

Only on error events: why the deploy failed, for example AUTHENTICATION_REQUIRED, INVALID_BRANCH or CLONE_FAILED.

string

Only on some error events: details about the failure.

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

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

List 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": "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" }
        ]
    ]
}

Get started

Account

Applications

Databases

Workspaces

AI

Parameters

Response

​Parameters

​Response

​Related

Parameters

Response

Related