All Applications Status

GET

apps

status

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

import requests

url = "https://api.squarecloud.app/v2/apps/status"

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/status', 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/status",
  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/status"

	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/status")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/status")

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": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}

Authorization

string

required

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

Returns live CPU, RAM, and running state for every application you own in a single call, which is more efficient than looping over Get Application Status once per application. Pass workspaceId to scope the listing to a shared workspace instead of your own applications; the caller must be the workspace owner or a member. This is the endpoint the dashboard’s applications overview polls. It is rate limited to 15 requests every 60 seconds per user; the equivalent per-application endpoint has its own, separate limits. For continuous updates instead of polling, open a Real-time Logs connection per application.

Parameters

workspaceId

string

A workspace id. You can found it below your workspace name on dashboard.

If workspaceId isn’t provided, will get your account applications status.

Response

status

string

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

response

object

The contents of the response.

Show Toggle object

string

The application ID.

cpu

string

The CPU usage of the application.

ram

string

The RAM usage of the application.

running

boolean

Indicates whether the application is currently running.

{
  "status": "success",
  "response": [
    {
      "id": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}

Common errors

Code	HTTP	Meaning
`WORKSPACE_NOT_FOUND`	404	The `workspaceId` does not exist or the caller is not the owner or a member.

Get Service StatusCheck the real-time status of Square Cloud services.

All Applications Status

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

import requests

url = "https://api.squarecloud.app/v2/apps/status"

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/status', 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/status",
  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/status"

	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/status")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/status")

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": "5bbd020126ee4692aga43e0ca0a75454",
      "cpu": "0.00%",
      "ram": "55.88MB",
      "running": true
    },
    {
      "id": "e1b286ba30f14a87baed4b4ad3b53c47",
      "cpu": "0.01%",
      "ram": "68.44MB",
      "running": true
    }
  ]
}

​Parameters

​Response

​Common errors

Parameters

Response

Common errors