Raise an alarm on a component
const url = 'https://example.com/api/v1/components/example/alarms';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"capabilities":["example"],"message":"example","severity":"info"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/components/example/alarms \ --header 'Content-Type: application/json' \ --data '{ "capabilities": [ "example" ], "message": "example", "severity": "info" }'Records a condition on this component and the capabilities it degrades, then recomputes health in the same transaction: any role requiring a degraded capability can no longer be filled by this component, and its system and location verdicts move with it. An unknown capability is a 422. Gated by component:update; an out-of-scope component is a non-disclosing 404.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The component’s unique name
The component’s unique name
Request Body required
Section titled “Request Body required ”object
A URL to the JSON Schema for this object.
The capabilities this condition degrades; a role requiring one of them can no longer be filled by this component
What is wrong, for the operator reading it later
How bad it is; critical puts the component itself in outage
Responses
Section titled “ Responses ”Created
object
A URL to the JSON Schema for this object.
The capabilities this alarm degrades; empty means it reaches no role
Null while the alarm is active
Info, warning, or critical
Example
{ "$schema": "/api/v1/schemas/AlarmBody.json"}default
Section titled “default ”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{ "$schema": "/api/v1/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}