SLO Burn Rate Rule
Create SLO Burn Rate Rule
Endpoint to create a new SLO Burn Rate Rule
post/service-level-objective-burn-rate-rule
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"data": {
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"serviceLevelObjectiveId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "Example Text",
"burnRateThreshold": 42,
"longWindowInMinutes": 42,
"shortWindowInMinutes": 42
}
}Response
Created successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"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"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"serviceLevelObjective": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"serviceLevelObjectiveId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"name": "Example Text",
"isEnabled": true,
"burnRateThreshold": 42,
"longWindowInMinutes": 42,
"shortWindowInMinutes": 42,
"minimumSampleCount": 42,
"refireSuppressionMinutes": 42,
"shouldCreateAlert": true,
"shouldCreateIncident": true,
"alertSeverity": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"alertSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"onCallDutyPolicies": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"alertTitleTemplate": "This is an example of longer text content that provides detailed information.",
"alertDescriptionTemplate": null,
"alertRemediationNotes": null,
"isAlertPrivate": true,
"autoResolveAlert": true,
"alertLabels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"alertOwnerTeams": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"alertOwnerUsers": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentSeverity": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"incidentSeverityId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"incidentOnCallDutyPolicies": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentTitleTemplate": "This is an example of longer text content that provides detailed information.",
"incidentDescriptionTemplate": null,
"incidentRemediationNotes": null,
"isIncidentPrivate": true,
"autoResolveIncident": true,
"incidentLabels": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentOwnerTeams": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"incidentOwnerUsers": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"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"
},
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.