Replace status page structure
curl --request PUT \
--url https://app.larm.dev/api/v1/status-pages/{id}/structure \
--header 'Content-Type: application/json' \
--data '
{
"components": [
{}
]
}
'import requests
url = "https://app.larm.dev/api/v1/status-pages/{id}/structure"
payload = { "components": [{}] }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({components: [{}]})
};
fetch('https://app.larm.dev/api/v1/status-pages/{id}/structure', 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}/structure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'components' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.larm.dev/api/v1/status-pages/{id}/structure"
payload := strings.NewReader("{\n \"components\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.larm.dev/api/v1/status-pages/{id}/structure")
.header("Content-Type", "application/json")
.body("{\n \"components\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.larm.dev/api/v1/status-pages/{id}/structure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"components\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"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": null,
"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"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T14:30:00Z"
}
}
Status pages
Replace status page structure
Atomically replaces the entire components-and-groups tree of a status page
PUT
/
api
/
v1
/
status-pages
/
{id}
/
structure
Replace status page structure
curl --request PUT \
--url https://app.larm.dev/api/v1/status-pages/{id}/structure \
--header 'Content-Type: application/json' \
--data '
{
"components": [
{}
]
}
'import requests
url = "https://app.larm.dev/api/v1/status-pages/{id}/structure"
payload = { "components": [{}] }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({components: [{}]})
};
fetch('https://app.larm.dev/api/v1/status-pages/{id}/structure', 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}/structure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'components' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.larm.dev/api/v1/status-pages/{id}/structure"
payload := strings.NewReader("{\n \"components\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.larm.dev/api/v1/status-pages/{id}/structure")
.header("Content-Type", "application/json")
.body("{\n \"components\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.larm.dev/api/v1/status-pages/{id}/structure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"components\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"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": null,
"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"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T14:30:00Z"
}
}
Requires
Component
status_pages:read_write permission.
Replaces the page’s full structure in a single transaction: creates new entries (omit id), updates existing entries by id, and deletes any entry not present in the body. Order is taken from the array (0-based position).
string
required
Status page ID (UUID)
object[]
required
Polymorphic tree of
group and component entries. Groups contain components (groups cannot nest). Ungrouped components appear at the top level.Entry shapes
Group| Field | Type | Notes |
|---|---|---|
type | string | Must be "group" |
id | string | Omit to create a new group; provide to update an existing one |
name | string | Required |
components | object[] | Components inside this group |
| Field | Type | Notes |
|---|---|---|
type | string | Must be "component" |
id | string | Omit to create a new component; provide to update an existing one |
name | string | Required |
description | string | Optional |
monitors | object[] | Each entry has monitor_id (UUID) and down_status (degraded_performance | partial_outage | major_outage) |
Errors
| Status | Reason |
|---|---|
| 404 | Status page not found |
| 422 | Body is missing components, an entry has an invalid type, or a group is nested inside another group |
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Acme Status",
"slug": "acme",
"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": null,
"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"
}
],
"inserted_at": "2025-03-01T12:00:00Z",
"updated_at": "2025-03-01T14:30:00Z"
}
}