Open Incident

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Use the hub_url received in the registration response as your base URL.

📘

This API requires the device to authenticate, see Device Authentication.

Open a custom incident on the device that are not covered by telemetry Incident Rules. This API allows the device to open custom incidents based on detected errors or internal state.

The device should call the Close Incident API to close the incident once the issue was resolved.

Return Data

NameTypeDescription
incident_idUUIDUnique identifier of the created incident. Should be used in the Close Incident API to close the incident once resolved.
{
	"incident_id": "3dce7586-7c40-4392-affb-f728f20bb350"
}

Notes

Incident generation will only work for claimed devices. Calling the API for unclaimed device will return successfully with a dummy incident_id.

Path Params
string
required
Body Params
string
required

Short title

string
enum
Defaults to 3

Critical, High, Moderate, Low, Planning

Allowed:
string
string
Defaults to Randomly generated tag

Short text to uniquely identify the issue (only one incident of each issue type can be open at a time)

string
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json