Skip to main content
GET
/
api
/
v1
/
status.json
Get overall status of a status page
curl --request GET \
  --url https://{custom_domain}/api/v1/status.json
import requests

url = "https://{custom_domain}/api/v1/status.json"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://{custom_domain}/api/v1/status.json', 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://{custom_domain}/api/v1/status.json",
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://{custom_domain}/api/v1/status.json"

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://{custom_domain}/api/v1/status.json")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{custom_domain}/api/v1/status.json")

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
{
  "page": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "time_zone": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": {
    "description": "<string>"
  },
  "incidents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "monitoring_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "shortlink": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "incident_updates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "body": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "display_at": "2023-11-07T05:31:56Z",
          "custom_tweet": "<string>",
          "deliver_notifications": true,
          "tweet_id": "<string>"
        }
      ]
    }
  ]
}
{
"error": "<string>",
"message": "<string>"
}

Response

status found

page
object
status
object
incidents
object[]