Get status page
curl --request GET \
--url https://app.larm.dev/api/v1/status-pages/{id}import requests
url = "https://app.larm.dev/api/v1/status-pages/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.larm.dev/api/v1/status-pages/{id}', 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://app.larm.dev/api/v1/status-pages/{id}",
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://app.larm.dev/api/v1/status-pages/{id}"
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://app.larm.dev/api/v1/status-pages/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.larm.dev/api/v1/status-pages/{id}")
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": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"description": "Current status of Acme services",
"theme": "system",
"primary_color": "#4F46E5",
"enabled": true,
"subscribers_enabled": true,
"custom_domain": null,
"domain_status": "none",
"logo_light_url": null,
"logo_dark_url": null,
"url": "https://acme.status.larm.dev",
"components": [
{
"type": "group",
"id": "880e8400-e29b-41d4-a716-446655440000",
"name": "Backend",
"position": 0,
"components": [
{
"type": "component",
"id": "770e8400-e29b-41d4-a716-446655440000",
"name": "API",
"description": "REST API",
"position": 0,
"monitors": [
{
"monitor_id": "660e8400-e29b-41d4-a716-446655440000",
"down_status": "major_outage"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
},
{
"type": "component",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "Marketing site",
"description": null,
"position": 1,
"monitors": [],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
}
Status pages
Get status page
Returns a single status page by ID, with its full components tree
GET
/
api
/
v1
/
status-pages
/
{id}
Get status page
curl --request GET \
--url https://app.larm.dev/api/v1/status-pages/{id}import requests
url = "https://app.larm.dev/api/v1/status-pages/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.larm.dev/api/v1/status-pages/{id}', 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://app.larm.dev/api/v1/status-pages/{id}",
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://app.larm.dev/api/v1/status-pages/{id}"
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://app.larm.dev/api/v1/status-pages/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.larm.dev/api/v1/status-pages/{id}")
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": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"description": "Current status of Acme services",
"theme": "system",
"primary_color": "#4F46E5",
"enabled": true,
"subscribers_enabled": true,
"custom_domain": null,
"domain_status": "none",
"logo_light_url": null,
"logo_dark_url": null,
"url": "https://acme.status.larm.dev",
"components": [
{
"type": "group",
"id": "880e8400-e29b-41d4-a716-446655440000",
"name": "Backend",
"position": 0,
"components": [
{
"type": "component",
"id": "770e8400-e29b-41d4-a716-446655440000",
"name": "API",
"description": "REST API",
"position": 0,
"monitors": [
{
"monitor_id": "660e8400-e29b-41d4-a716-446655440000",
"down_status": "major_outage"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
},
{
"type": "component",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "Marketing site",
"description": null,
"position": 1,
"monitors": [],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
}
Requires
The
status_pages:read permission.
string
required
Status page ID (UUID)
components field is a polymorphic tree of group and component entries, ordered by position. Groups contain components (groups cannot nest). Ungrouped components appear at the top level.
To replace the entire tree, use PUT structure. For individual CRUD on components and groups, see the Components and Component groups endpoints.
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"description": "Current status of Acme services",
"theme": "system",
"primary_color": "#4F46E5",
"enabled": true,
"subscribers_enabled": true,
"custom_domain": null,
"domain_status": "none",
"logo_light_url": null,
"logo_dark_url": null,
"url": "https://acme.status.larm.dev",
"components": [
{
"type": "group",
"id": "880e8400-e29b-41d4-a716-446655440000",
"name": "Backend",
"position": 0,
"components": [
{
"type": "component",
"id": "770e8400-e29b-41d4-a716-446655440000",
"name": "API",
"description": "REST API",
"position": 0,
"monitors": [
{
"monitor_id": "660e8400-e29b-41d4-a716-446655440000",
"down_status": "major_outage"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
},
{
"type": "component",
"id": "990e8400-e29b-41d4-a716-446655440000",
"name": "Marketing site",
"description": null,
"position": 1,
"monitors": [],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T12:00:00Z"
}
}
⌘I