List Deployments - Square Cloud

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

required

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

Use this endpoint to inspect what happened during recent deploys: each inner array captures one deploy attempt’s lifecycle, moving through pending, clone (Git-driven deploys only), commit, restarting, and success states. Every event carries a derived source field: git when the deploy came from a webhook or GitHub App push, upload when it came from a zip upload or a Commit Application call. 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 successful, error if not.

array

The contents of the response.

Show Toggle object

string

The ID of the deploy.

string

The state of the deploy. Can be pending, clone, success, or error.

string

The date the deploy was created.

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

Get Current DeploymentGet the current deployment information for an application.

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

​Parameters

​Response

Parameters

Response