Skip to main content
PATCH
/
api
/
v1
/
status-pages
/
{status_page_id}
/
components
/
{id}
Update component
curl --request PATCH \
  --url https://app.larm.dev/api/v1/status-pages/{status_page_id}/components/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "position": 123,
  "component_group_id": "<string>",
  "monitors": [
    {}
  ]
}
'
import requests

url = "https://app.larm.dev/api/v1/status-pages/{status_page_id}/components/{id}"

payload = {
"name": "<string>",
"description": "<string>",
"position": 123,
"component_group_id": "<string>",
"monitors": [{}]
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
position: 123,
component_group_id: '<string>',
monitors: [{}]
})
};

fetch('https://app.larm.dev/api/v1/status-pages/{status_page_id}/components/{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/{status_page_id}/components/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'position' => 123,
'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/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"position\": 123,\n \"component_group_id\": \"<string>\",\n \"monitors\": [\n {}\n ]\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://app.larm.dev/api/v1/status-pages/{status_page_id}/components/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"position\": 123,\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/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"position\": 123,\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 v2",
    "description": "Updated API",
    "position": 0,
    "component_group_id": null,
    "monitors": [],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T13:00:00Z"
  }
}
Requires status_pages:read_write permission.
status_page_id
string
required
Status page UUID
id
string
required
Component UUID
name
string
Component name
description
string
Component description
position
integer
Display position
component_group_id
string
Group UUID
monitors
object[]
Replaces all linked monitors. Each object has monitor_id (monitor UUID) and down_status.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API v2",
    "description": "Updated API",
    "position": 0,
    "component_group_id": null,
    "monitors": [],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T13:00:00Z"
  }
}