Get current deployment

GET

apps

{app_id}

deployments

current

Get current deployment

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/<webhook-code>"
    }
}

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

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. This endpoint reports how the application is currently wired for Git-based deploys: a GitHub App repository linkage, a legacy webhook URL, or both, depending on how the integration was set up. Use it to check the tracked repository and branch before troubleshooting a deploy, or to confirm whether a webhook still needs to be generated. The response is cached for 5 minutes per owner and application, so changes made through Set GitHub Webhook may take a few minutes to show up here. On workspace-shared applications, the caller needs the manager or admin role, or ownership. To see deploy history rather than the current configuration, use List Deployments. The webhook URL works as a deploy credential, so it is returned in full only to a caller that can configure it: an API key with the apps:deploy scope (or full access) or, on a workspace-shared application, the admin role or ownership. Anyone else, such as an apps:read key or a manager, gets it masked (https://api.squarecloud.app/v2/git/webhook/********), which still tells you a webhook is configured.

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.

object

The contents of the response.

Show properties

string

The webhook URL for the application. Masked (.../webhook/********) for a caller that cannot configure it.

{
    "status": "success",
    "response": {
        "webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
    }
}

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

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

Get current deployment

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/<webhook-code>"
    }
}

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

Get started

Account

Applications

Databases

Workspaces

AI

Parameters

Response

​Parameters

​Response

​Related

Parameters

Response

Related