Get Service Status - Square Cloud

GET

service

status

Get Service Status

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

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.squarecloud.app/v2/service/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/service/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: <api-key>"
  ],
]);

$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/service/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
    "status": "online",
    "message": "All services are online."
}

Service Status returns the aggregate health of the Square Cloud platform, the same signal that powers the public status page and internal alerting. It’s a public route with no API key required, which makes it a good fit for automated uptime checks or a small status widget on your own site. The payload is served from a 5-minute cache, so it can lag a transient incident by up to that window and should not be treated as a live incident feed. If the cached value can’t be read, the endpoint still responds successfully with status: "unknown" instead of failing the request. For per-application health instead of the whole platform, see Get Application Status or Get All Applications Status.

This route has a 5-minute cache and does not reflect the real-time status of status.squarecloud.app.

Response

status

string

The current status of Square Cloud, with online indicating the service is online, degraded indicating issues, and unknown indicating unavailable.

message

string

Message about the current status of Square Cloud services.

{
    "status": "online",
    "message": "All services are online."
}

Get Application InfoRetrieve technical information about your application.

Get Service Status

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

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.squarecloud.app/v2/service/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/service/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: <api-key>"
  ],
]);

$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/service/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
    "status": "online",
    "message": "All services are online."
}

​Response

Response