{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/statuswerk.eu" } ], "info": { "name": "Statuswerk API Reference", "_postman_id": "ec95bbb0-8b4d-4ef6-b82c-492f3d2787d1", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Endpoints", "description": "", "item": [ { "name": "Get the current statuspage details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspage", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspage" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update the statuspage settings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspage", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspage" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"timezone\":\"Asia\\\/Ulaanbaatar\",\"language\":\"gzmiyv\",\"is_public\":false,\"allow_subscriptions\":true,\"show_uptime\":false,\"uptime_days_to_show\":1,\"allow_email_subscribers\":false,\"allow_sms_subscribers\":false,\"allow_webhook_subscribers\":true,\"allow_rss_subscribers\":true,\"meta_title\":\"l\",\"meta_description\":\"j\"}" }, "description": "" }, "response": [] }, { "name": "Get overall status summary (useful for CI\/CD checks).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspage\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspage\/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List all components.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new component.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Et animi quos velit et fugiat.\",\"group_id\":\"5707ca55-f609-3528-be8b-1baeaee1567e\",\"status\":\"partial_outage\",\"position\":9,\"show_uptime\":false,\"uptime_start_date\":\"2026-09-10T11:02:16\",\"visible\":true}" }, "description": "" }, "response": [] }, { "name": "Get a specific component.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the component." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a component.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the component." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Et animi quos velit et fugiat.\",\"group_id\":\"5707ca55-f609-3528-be8b-1baeaee1567e\",\"status\":\"partial_outage\",\"position\":9,\"show_uptime\":false,\"uptime_start_date\":\"2026-09-10T11:02:16\",\"visible\":true}" }, "description": "" }, "response": [] }, { "name": "Delete a component.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the component." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Update component status (CI\/CD-friendly endpoint).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components\/:component\/status", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components\/:component\/status", "variable": [ { "id": "component", "key": "component", "value": "architecto", "description": "The component." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"major_outage\"}" }, "description": "" }, "response": [] }, { "name": "Reorder components.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/components\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/v1\/components\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"components\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"position\":84}]}" }, "description": "" }, "response": [] }, { "name": "List all component groups.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/component-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/component-groups" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new component group.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/component-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/component-groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Et animi quos velit et fugiat.\",\"position\":42,\"collapsed_by_default\":true,\"visible\":true}" }, "description": "" }, "response": [] }, { "name": "Get a specific component group.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/component-groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/component-groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the component group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a component group.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/component-groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/component-groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the component group." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"description\":\"Et animi quos velit et fugiat.\",\"position\":42,\"collapsed_by_default\":false,\"visible\":true}" }, "description": "" }, "response": [] }, { "name": "Delete a component group.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/component-groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/component-groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the component group." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List all incidents.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new incident.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"message\":\"n\",\"status\":\"resolved\",\"severity\":\"major\",\"impact\":\"g\",\"visible\":true,\"stickied\":true,\"notify_subscribers\":false,\"occurred_at\":\"2026-09-10T11:02:16\",\"components\":[{\"id\":\"c90237e9-ced5-3af6-88ea-84aeaa148878\",\"status\":\"degraded_performance\"}]}" }, "description": "" }, "response": [] }, { "name": "Get a specific incident.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the incident." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update an incident.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the incident." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"message\":\"n\",\"status\":\"investigating\",\"severity\":\"major\",\"impact\":\"g\",\"visible\":true,\"stickied\":false,\"notify_subscribers\":true,\"components\":[{\"id\":\"c90237e9-ced5-3af6-88ea-84aeaa148878\",\"status\":\"operational\"}]}" }, "description": "" }, "response": [] }, { "name": "Delete an incident.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the incident." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List all updates for an incident.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:incident_id\/updates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:incident_id\/updates", "variable": [ { "id": "incident_id", "key": "incident_id", "value": "architecto", "description": "The ID of the incident." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new incident update.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:incident_id\/updates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:incident_id\/updates", "variable": [ { "id": "incident_id", "key": "incident_id", "value": "architecto", "description": "The ID of the incident." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"identified\",\"message\":\"b\",\"notify_subscribers\":true}" }, "description": "" }, "response": [] }, { "name": "Resolve an incident (CI\/CD-friendly endpoint).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incidents\/:incident\/resolve", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incidents\/:incident\/resolve", "variable": [ { "id": "incident", "key": "incident", "value": "architecto", "description": "The incident." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"message\":\"b\",\"notify_subscribers\":false}" }, "description": "" }, "response": [] }, { "name": "List all incident templates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incident-templates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incident-templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new incident template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incident-templates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incident-templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"title_template\":\"n\",\"message_template\":\"g\",\"default_status\":\"monitoring\",\"default_severity\":\"minor\",\"visible\":false,\"stickied\":false,\"notify_subscribers\":false,\"default_component_ids\":[\"c90237e9-ced5-3af6-88ea-84aeaa148878\"]}" }, "description": "" }, "response": [] }, { "name": "Get a specific incident template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incident-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incident-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the incident template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update an incident template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incident-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incident-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the incident template." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"title_template\":\"n\",\"message_template\":\"g\",\"default_status\":\"identified\",\"default_severity\":\"minor\",\"visible\":false,\"stickied\":true,\"notify_subscribers\":true,\"default_component_ids\":[\"c90237e9-ced5-3af6-88ea-84aeaa148878\"]}" }, "description": "" }, "response": [] }, { "name": "Delete an incident template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incident-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incident-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the incident template." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Open an incident from this template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/incident-templates\/:incident_template\/apply", "query": [], "raw": "{{baseUrl}}\/api\/v1\/incident-templates\/:incident_template\/apply", "variable": [ { "id": "incident_template", "key": "incident_template", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"occurred_at\":\"2026-09-10T11:02:16\",\"variables\":[\"b\"]}" }, "description": "The endpoint CI\/CD and alerting hooks use: name the template, optionally pass\nvariables for the placeholders, and every other field comes from the template." }, "response": [] }, { "name": "List all scheduled maintenances.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new scheduled maintenance.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"message\":\"n\",\"scheduled_start_at\":\"2052-10-03\",\"scheduled_end_at\":\"2052-10-03\",\"auto_start\":true,\"auto_complete\":true,\"notify_subscribers\":true,\"notify_at_scheduled\":false,\"send_reminder_1h\":false,\"notify_at_start\":true,\"notify_at_end\":false,\"update_component_status\":false,\"component_ids\":[\"a4855dc5-0acb-33c3-b921-f4291f719ca0\"]}" }, "description": "" }, "response": [] }, { "name": "Get a specific maintenance.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the maintenance." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a maintenance.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the maintenance." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"message\":\"n\",\"scheduled_start_at\":\"2026-09-10T11:02:16\",\"scheduled_end_at\":\"2052-10-03\",\"auto_start\":true,\"auto_complete\":true,\"notify_subscribers\":false,\"notify_at_scheduled\":false,\"send_reminder_1h\":false,\"notify_at_start\":false,\"notify_at_end\":false,\"update_component_status\":false,\"component_ids\":[\"a4855dc5-0acb-33c3-b921-f4291f719ca0\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a maintenance.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the maintenance." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Start a maintenance (CI\/CD-friendly endpoint).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances\/:maintenance\/start", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances\/:maintenance\/start", "variable": [ { "id": "maintenance", "key": "maintenance", "value": "architecto", "description": "The maintenance." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Complete a maintenance (CI\/CD-friendly endpoint).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenances\/:maintenance\/complete", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenances\/:maintenance\/complete", "variable": [ { "id": "maintenance", "key": "maintenance", "value": "architecto", "description": "The maintenance." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List all maintenance templates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenance-templates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenance-templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new maintenance template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenance-templates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenance-templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"title_template\":\"n\",\"message_template\":\"g\",\"default_duration_minutes\":16,\"notify_subscribers\":true,\"send_reminder_1h\":true,\"auto_start\":false,\"notify_at_start\":false,\"auto_complete\":false,\"notify_at_end\":false,\"update_component_status\":false,\"default_component_ids\":[\"977e5426-8d13-3824-86aa-b092f8ae52c5\"]}" }, "description": "" }, "response": [] }, { "name": "Get a specific maintenance template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenance-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenance-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the maintenance template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a maintenance template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenance-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenance-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the maintenance template." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"title_template\":\"n\",\"message_template\":\"g\",\"default_duration_minutes\":16,\"notify_subscribers\":false,\"send_reminder_1h\":false,\"auto_start\":true,\"notify_at_start\":false,\"auto_complete\":true,\"notify_at_end\":true,\"update_component_status\":true,\"default_component_ids\":[\"977e5426-8d13-3824-86aa-b092f8ae52c5\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a maintenance template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenance-templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenance-templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the maintenance template." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Create a scheduled maintenance from this template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/maintenance-templates\/:maintenance_template\/apply", "query": [], "raw": "{{baseUrl}}\/api\/v1\/maintenance-templates\/:maintenance_template\/apply", "variable": [ { "id": "maintenance_template", "key": "maintenance_template", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"scheduled_start_at\":\"2026-09-10T11:02:16\",\"scheduled_end_at\":\"2052-10-03\",\"variables\":[\"n\"]}" }, "description": "This is the endpoint CI\/CD and schedulers use: pick the template, give it a start\ntime, and every other field comes from the template." }, "response": [] }, { "name": "GET api\/v1\/metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"b\",\"name\":\"n\",\"suffix\":\"gzmiyvdljnikhway\",\"decimals\":1,\"aggregation\":\"avg\",\"description\":\"Omnis nostrum aut adipisci quidem nostrum qui commodi.\",\"visible\":false,\"position\":3,\"y_axis_min\":4326.41688,\"y_axis_max\":4326.41688}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/metrics\/{metricKey}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics\/:metricKey", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics\/:metricKey", "variable": [ { "id": "metricKey", "key": "metricKey", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "PUT api\/v1\/metrics\/{metricKey}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics\/:metricKey", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics\/:metricKey", "variable": [ { "id": "metricKey", "key": "metricKey", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"b\",\"name\":\"n\",\"suffix\":\"gzmiyvdljnikhway\",\"decimals\":1,\"aggregation\":\"min\",\"description\":\"Omnis nostrum aut adipisci quidem nostrum qui commodi.\",\"visible\":false,\"position\":3,\"y_axis_min\":4326.41688,\"y_axis_max\":4326.41688}" }, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/metrics\/{metricKey}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics\/:metricKey", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics\/:metricKey", "variable": [ { "id": "metricKey", "key": "metricKey", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Push one point or a batch.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics\/:metricKey\/points", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics\/:metricKey\/points", "variable": [ { "id": "metricKey", "key": "metricKey", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"points\":[{\"value\":4326.41688,\"timestamp\":\"2026-09-10T11:02:16\"}]}" }, "description": "Idempotent: points are bucketed on write, so a client retrying a failed request\noverwrites rather than duplicates." }, "response": [] }, { "name": "Read points back, for the customer's own dashboards or to verify an import.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics\/:metricKey\/points", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics\/:metricKey\/points", "variable": [ { "id": "metricKey", "key": "metricKey", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2026-09-10T11:02:16\",\"to\":\"2026-09-10T11:02:16\",\"resolution\":16}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List all subscribers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/subscribers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/subscribers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new subscriber.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/subscribers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/subscribers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"phone\":\"m\",\"webhook_url\":\"https:\\\/\\\/www.gulgowski.com\\\/nihil-accusantium-harum-mollitia-modi-deserunt\",\"webhook_type\":\"generic\",\"webhook_secret\":\"w\",\"channels\":[\"sms\"],\"component_ids\":[\"3c85cf54-98c1-36ed-b65a-abaafdecdfa9\"],\"locale\":\"es_MX\",\"skip_verification\":true}" }, "description": "" }, "response": [] }, { "name": "Get a specific subscriber.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/subscribers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/subscribers\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the subscriber." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Delete a subscriber.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/subscribers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/subscribers\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the subscriber." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Resend verification email.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/subscribers\/:subscriber\/resend-verification", "query": [], "raw": "{{baseUrl}}\/api\/v1\/subscribers\/:subscriber\/resend-verification", "variable": [ { "id": "subscriber", "key": "subscriber", "value": "architecto", "description": "The subscriber." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List all integrations for the current statuspage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"discord\",\"name\":\"b\",\"url\":\"http:\\\/\\\/bailey.com\\\/\",\"is_enabled\":true,\"events\":[\"incident.resolved\"]}" }, "description": "" }, "response": [] }, { "name": "Get a specific integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the integration." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update an integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the integration." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"slack\",\"name\":\"b\",\"url\":\"http:\\\/\\\/bailey.com\\\/\",\"is_enabled\":true,\"events\":[\"incident.created\"]}" }, "description": "" }, "response": [] }, { "name": "Delete an integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the integration." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Send a test webhook to an integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integrations\/:integration\/test", "query": [], "raw": "{{baseUrl}}\/api\/v1\/integrations\/:integration\/test", "variable": [ { "id": "integration", "key": "integration", "value": "architecto", "description": "The integration." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/v1\/statuspages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/statuspages", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"subdomain\":\"n\",\"timezone\":\"Antarctica\\\/Rothera\",\"language\":\"zmiyvd\"}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/statuspages\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the statuspage." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "DELETE api\/v1\/statuspages\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the statuspage." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "GET api\/v1\/statuspages\/{statuspage_id}\/custom-domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages\/:statuspage_id\/custom-domain", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages\/:statuspage_id\/custom-domain", "variable": [ { "id": "statuspage_id", "key": "statuspage_id", "value": "architecto", "description": "The ID of the statuspage." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "PUT api\/v1\/statuspages\/{statuspage_id}\/custom-domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages\/:statuspage_id\/custom-domain", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages\/:statuspage_id\/custom-domain", "variable": [ { "id": "statuspage_id", "key": "statuspage_id", "value": "architecto", "description": "The ID of the statuspage." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"domain\":\"b\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/statuspages\/{statuspage}\/custom-domain\/verify", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages\/:statuspage\/custom-domain\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages\/:statuspage\/custom-domain\/verify", "variable": [ { "id": "statuspage", "key": "statuspage", "value": "architecto", "description": "The statuspage." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/statuspages\/{statuspage_id}\/custom-domain", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/statuspages\/:statuspage_id\/custom-domain", "query": [], "raw": "{{baseUrl}}\/api\/v1\/statuspages\/:statuspage_id\/custom-domain", "variable": [ { "id": "statuspage_id", "key": "statuspage_id", "value": "architecto", "description": "The ID of the statuspage." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }