Get the overall status (public)
curl --request GET \
--url https://{domain}/api/public/modules/status/summaryimport requests
url = "https://{domain}/api/public/modules/status/summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{domain}/api/public/modules/status/summary', 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://{domain}/api/public/modules/status/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{domain}/api/public/modules/status/summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/public/modules/status/summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/public/modules/status/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"state": "operational",
"all_operational": true,
"total": 1,
"online": 1,
"offline": 0,
"maintenance": 0,
"average_uptime": 100,
"updated_at": "2026-11-16T15:35:20Z"
},
"meta": {
"request_id": "6dfe8ec8-18a5-4971-ac35-a1bba8d3824c"
}
}{
"error": {
"code": "too_many_requests",
"message": "Too many requests. Retry after the number of seconds in the Retry-After header.",
"details": {}
},
"request_id": "db4f5a74-f1c8-4554-a36b-7dced81670a8"
}Status (public)
Get the overall status (public)
Overall state and counts, the same data as the banner on the status page. Cheap enough to poll.
This is the public, keyless version. It only returns what an anonymous visitor can see on your site, is cached for 60 seconds (edits in the admin area show up at once) and allows 60 requests per minute per IP.
Authentication: none, no API key needed.
Rate limit: 60 requests per minute per IP.
GET
/
public
/
modules
/
status
/
summary
Get the overall status (public)
curl --request GET \
--url https://{domain}/api/public/modules/status/summaryimport requests
url = "https://{domain}/api/public/modules/status/summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{domain}/api/public/modules/status/summary', 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://{domain}/api/public/modules/status/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{domain}/api/public/modules/status/summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{domain}/api/public/modules/status/summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/public/modules/status/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"state": "operational",
"all_operational": true,
"total": 1,
"online": 1,
"offline": 0,
"maintenance": 0,
"average_uptime": 100,
"updated_at": "2026-11-16T15:35:20Z"
},
"meta": {
"request_id": "6dfe8ec8-18a5-4971-ac35-a1bba8d3824c"
}
}{
"error": {
"code": "too_many_requests",
"message": "Too many requests. Retry after the number of seconds in the Retry-After header.",
"details": {}
},
"request_id": "db4f5a74-f1c8-4554-a36b-7dced81670a8"
}Was this page helpful?

