Status / Update

Update an existing status page. Send the full payload, including guid, appearance fields, layout, and embed_origins.

Endpoint

Method POST
Url https://downdar.com/api/v1/status/update

Request

Key fields

guid key Status page id.

Fields

name req String, max 255 characters.
title_url opt Optional http or https URL for the page title link.
theme opt dark, light
display_mode opt compact, detailed
show_targets opt Boolean.
page_background_hex opt Hex color.
header_color_hex opt Hex color.
text_color_hex opt Hex color.
published req draft, published
noindex opt Boolean.
embed_origins opt Array of hostnames allowed to embed this page. Requires the embed feature on your plan.
layout req Full page layout. Replaces the current sections and monitors.

layout.sections[]

id opt Existing section id. Omit or set 0 for a new section.
ref opt Client reference for new sections. Monitors can use this in section_ref.
name req Section name.
sort_order opt Display order.

layout.monitors[]

monitor_type req http, ping, tcp, ssl, dns, heartbeat
guid req Monitor id.
display_name opt Optional override label.
section_id opt Existing section id, or null for the root list.
section_ref opt Reference to a new section ref when section_id is not available yet.
sort_order opt Display order.
{ "guid": "550e8400-e29b-41d4-a716-446655440000", "name": "Production status", "title_url": "https://example.com", "theme": "dark", "display_mode": "compact", "show_targets": true, "page_background_hex": "#262626", "header_color_hex": "#1C1C1C", "text_color_hex": "#BBBBBB", "published": "published", "noindex": false, "embed_origins": [], "layout": { "sections": [ { "id": 12, "name": "Core services", "sort_order": 0 } ], "monitors": [ { "monitor_type": "http", "guid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "display_name": "", "section_id": 12, "sort_order": 0 } ] } }

Response

Top level

ok Always true on success.
status_page Updated status page object.
capacity Status page quota for the account.
rate_limit Rate limit state for the tier this endpoint consumes. Present on every successful response.

rate_limit

tier Rate tier this endpoint counts against (1-5).
cost Units consumed by this request against the tier window.
timeframe Rolling limit window: second, minute, hour, or day.
limit Maximum units allowed in the timeframe for this tier on your plan.
used Units already used in the current window.
remaining Units left before this tier returns HTTP 429.
{ "ok": true, "status_page": { "guid": "550e8400-e29b-41d4-a716-446655440000", "name": "Production status", "title_url": "https://example.com", "theme": "dark", "display_mode": "compact", "show_targets": true, "page_background_hex": "#262626", "header_color_hex": "#1C1C1C", "text_color_hex": "#BBBBBB", "published": "published", "noindex": false, "public_url": "https://example.com/status/550e8400-e29b-41d4-a716-446655440000", "embed_origins": [], "layout": { "sections": [ { "id": 12, "name": "Core services", "sort_order": 0 } ], "monitors": [ { "monitor_type": "http", "guid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", "display_name": "", "name": "API", "section_id": 12, "sort_order": 0 } ] }, "monitor_count": 1 }, "capacity": { "limit": 5, "used": 1, "remaining": 4 }, "rate_limit": { "tier": 1, "cost": 1, "timeframe": "minute", "limit": 60, "used": 12, "remaining": 48 } }