Download OpenAPI specification:Download
All incidents are assigned a unique identifier, and this endpoint allows information about an incident to be retrieved on an incident-by-incident basis.
id required | integer <int32> |
Change display information like the title or severity of an incident here. Note that once an incident state has been marked as resolved, this endpoint will cease to work.
apikey
) id required | integer <int32> |
title | string Nullable |
caused_status | integer <int32> (ServiceStatus) Enum: 0 1 2 |
{- "title": "string",
- "caused_status": 0
}
As the state of an incident changes, this endpoint allows updates to be appended to the incident view.
apikey
) id required | integer <int32> |
message required | string |
state required | integer <int32> (IncidentState) Enum: 0 1 2 3 |
{- "message": "string",
- "state": 0
}
This endpoint creates or updates a new key-value association in the KV table.
apikey
) key required | string |
value required | string <= 8192 characters |
{- "key": "string",
- "value": "string"
}
The KV API can be provided with an array of strings to search the values of. Any missing entries will be returned with a null value.
[- "string"
]
apikey
) key | string Nullable |
If you have a custom metric, it can be retrieved from this endpoint by id. By default the 60 most recent entries are returned.
id required | integer <int32> |
limit | integer <int32> Default: 60 |
Removes a metric and all associated entries.
apikey
) id required | integer <int32> |
Creates a new metric entry and associates it with the provided metric id
apikey
) id required | integer <int32> |
tag | string Nullable |
value | integer <int32> |
{- "tag": "string",
- "value": 0
}
This endpoint is useful if you've been testing scripts that push to a custom metric, and you'd like to clear the sample entries before deploying.
apikey
) id required | integer <int32> |
apikey
) slug required | string |
display_name required | string |
description required | string |
{- "slug": "string",
- "display_name": "string",
- "description": "string"
}
This endpoint currently returns the entire incident history of a service. This may change in the future.
id required | integer <int32> |
You can specify how far into the past this endpoint will search as a query parameter.
id required | integer <int32> |
days | integer <int32> Default: 30 |
The status of the service will automatically be changed to that of the "worst" current incident.
apikey
) id required | integer <int32> |
title required | string |
message required | string |
state required | integer <int32> (IncidentState) Enum: 0 1 2 3 |
caused_status required | integer <int32> (ServiceStatus) Enum: 0 1 2 |
{- "title": "string",
- "message": "string",
- "state": 0,
- "caused_status": 0
}
All services automatically have their historic uptime calculated. This operation is expensive for services with a long history, and therefore results returned by this endpoint are cached after the first request.
id required | integer <int32> |
limit | integer <int32> Default: 60 |
apikey
) id required | integer <int32> |
name | string Nullable |
{- "name": "string"
}