SLO Burn Rate Rule
Get SLO Burn Rate Rule
Endpoint to retrieve a single SLO Burn Rate Rule by ID
post/service-level-objective-burn-rate-rule/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the SLO Burn Rate Rule to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"serviceLevelObjectiveId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Example short text",
"isEnabled": true,
"burnRateThreshold": 42,
"longWindowInMinutes": 42,
"shortWindowInMinutes": 42,
"minimumSampleCount": 42,
"refireSuppressionMinutes": 42,
"shouldCreateAlert": true,
"shouldCreateIncident": true,
"alertSeverityId": "123e4567-e89b-12d3-a456-426614174000",
"onCallDutyPolicies": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"alertTitleTemplate": "This is an example of longer text content that might be stored in this field.",
"alertDescriptionTemplate": "# Heading\n\nThis is **markdown** content",
"alertRemediationNotes": "# Heading\n\nThis is **markdown** content",
"isAlertPrivate": true,
"autoResolveAlert": true,
"alertLabels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"alertOwnerTeams": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"alertOwnerUsers": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"incidentSeverityId": "123e4567-e89b-12d3-a456-426614174000",
"incidentOnCallDutyPolicies": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"incidentTitleTemplate": "This is an example of longer text content that might be stored in this field.",
"incidentDescriptionTemplate": "# Heading\n\nThis is **markdown** content",
"incidentRemediationNotes": "# Heading\n\nThis is **markdown** content",
"isIncidentPrivate": true,
"autoResolveIncident": true,
"incidentLabels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"incidentOwnerTeams": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"incidentOwnerUsers": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"addSloOwnersAsOwners": true,
"lastAlertCreatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastAlertResolvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastIncidentCreatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastIncidentResolvedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.