Create component
curl --request POST \
--url https://app.larm.dev/api/v1/status-pages/{status_page_id}/components \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"position": 123,
"description": "<string>",
"component_group_id": "<string>",
"monitors": [
{}
]
}
'import requests
url = "https://app.larm.dev/api/v1/status-pages/{status_page_id}/components"
payload = {
"name": "<string>",
"position": 123,
"description": "<string>",
"component_group_id": "<string>",
"monitors": [{}]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
position: 123,
description: '<string>',
component_group_id: '<string>',
monitors: [{}]
})
};
fetch('https://app.larm.dev/api/v1/status-pages/{status_page_id}/components', 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/{status_page_id}/components",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'position' => 123,
'description' => '<string>',
'component_group_id' => '<string>',
'monitors' => [
[
]
]
]),
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/{status_page_id}/components"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"position\": 123,\n \"description\": \"<string>\",\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.larm.dev/api/v1/status-pages/{status_page_id}/components")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"position\": 123,\n \"description\": \"<string>\",\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.larm.dev/api/v1/status-pages/{status_page_id}/components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"position\": 123,\n \"description\": \"<string>\",\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API",
"description": "REST API endpoints",
"position": 0,
"component_group_id": null,
"monitors": [
{
"monitor_id": "660e8400-e29b-41d4-a716-446655440000",
"down_status": "major_outage"
}
],
"inserted_at": "2026-03-28T12:00:00Z",
"updated_at": "2026-03-28T12:00:00Z"
}
}
Components
Create component
Adds a component to a status page
POST
/
api
/
v1
/
status-pages
/
{status_page_id}
/
components
Create component
curl --request POST \
--url https://app.larm.dev/api/v1/status-pages/{status_page_id}/components \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"position": 123,
"description": "<string>",
"component_group_id": "<string>",
"monitors": [
{}
]
}
'import requests
url = "https://app.larm.dev/api/v1/status-pages/{status_page_id}/components"
payload = {
"name": "<string>",
"position": 123,
"description": "<string>",
"component_group_id": "<string>",
"monitors": [{}]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
position: 123,
description: '<string>',
component_group_id: '<string>',
monitors: [{}]
})
};
fetch('https://app.larm.dev/api/v1/status-pages/{status_page_id}/components', 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/{status_page_id}/components",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'position' => 123,
'description' => '<string>',
'component_group_id' => '<string>',
'monitors' => [
[
]
]
]),
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/{status_page_id}/components"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"position\": 123,\n \"description\": \"<string>\",\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.larm.dev/api/v1/status-pages/{status_page_id}/components")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"position\": 123,\n \"description\": \"<string>\",\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.larm.dev/api/v1/status-pages/{status_page_id}/components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"position\": 123,\n \"description\": \"<string>\",\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API",
"description": "REST API endpoints",
"position": 0,
"component_group_id": null,
"monitors": [
{
"monitor_id": "660e8400-e29b-41d4-a716-446655440000",
"down_status": "major_outage"
}
],
"inserted_at": "2026-03-28T12:00:00Z",
"updated_at": "2026-03-28T12:00:00Z"
}
}
Requires
status_pages:read_write permission.
Status page UUID
Component name (1–255 characters)
Display position (0-indexed)
Optional description
Optional group UUID to organize components under a heading
Monitors to link. Each object has
monitor_id (monitor UUID) and down_status (major_outage, partial_outage, or degraded_performance). Linked monitors trigger auto-disruptions when they detect failures.{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "API",
"description": "REST API endpoints",
"position": 0,
"component_group_id": null,
"monitors": [
{
"monitor_id": "660e8400-e29b-41d4-a716-446655440000",
"down_status": "major_outage"
}
],
"inserted_at": "2026-03-28T12:00:00Z",
"updated_at": "2026-03-28T12:00:00Z"
}
}
⌘I