Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

SLA policies set the performance commitments your team is held to when incidents occur. Each policy combines response and resolution time targets with breach thresholds, so the system can classify incidents that are trending toward or have exceeded acceptable limits. You can scope policies to specific teams and link them to escalation contacts for automated notification. All requests require a Bearer token in the Authorization header.

​
Create a policy

POST https://your-api-domain.com/api/v1/sla-policies Creates a new SLA policy. The policy is immediately active and will be evaluated against incoming incidents that match its applicableTeam.

​
Request body

​
name
string
required
A human-readable name for the policy.
​
priority
string
required
The incident priority this policy applies to. Accepted values: CRITICAL, HIGH, MEDIUM, LOW.
​
responseTimeMinutes
number
required
Target time in minutes within which the incident must receive a first response.
​
responseThreshold
number
required
Percentage of incidents that must meet the response time target (0–100).
​
resolveTimeMinutes
number
required
Target time in minutes within which the incident must be fully resolved.
​
resolveThreshold
number
required
Percentage of incidents that must meet the resolution time target (0–100).
​
escalationContact
string
required
The escalation tier or contact identifier to notify when a breach is detected.
​
applicableTeam
string
required
The team email or identifier this policy governs.
​
uptimeTarget
number
required
Required uptime percentage for services covered by this policy (e.g., 99.9).

​
Response fields

​
id
string
required
Unique identifier for the created policy.
​
name
string
required
Policy name.
​
priority
string
required
Priority level this policy targets.
​
breachStatus
string
required
Current breach classification. One of NONE, RESPONSE_BREACH, RESOLVE_BREACH, or BOTH.
​
createdAt
string
required
ISO 8601 timestamp of policy creation.
curl --request POST \
  --url https://your-api-domain.com/api/v1/sla-policies \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Critical Outage SLA",
    "priority": "CRITICAL",
    "responseTimeMinutes": 15,
    "responseThreshold": 90,
    "resolveTimeMinutes": 60,
    "resolveThreshold": 85,
    "escalationContact": "Tier1",
    "applicableTeam": "oncall@example.com",
    "uptimeTarget": 99.9
  }'

​
List all policies

GET https://your-api-domain.com/api/v1/sla-policies Returns all SLA policies defined for the account.

​
Response fields

​
policies
object[]
required
Array of SLA policy objects.
curl --request GET \
  --url https://your-api-domain.com/api/v1/sla-policies \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
Get a single policy

GET https://your-api-domain.com/api/v1/sla-policies/:id Retrieves the full configuration of a specific SLA policy.

​
Path parameters

​
id
string
required
The unique identifier of the SLA policy.
curl --request GET \
  --url https://your-api-domain.com/api/v1/sla-policies/sla_abc123 \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
Update a policy

PUT https://your-api-domain.com/api/v1/sla-policies/:id Replaces all fields of an existing SLA policy. Supply the full policy body — omitted fields revert to their defaults.

​
Path parameters

​
id
string
required
The unique identifier of the SLA policy to update.

​
Request body

The request body accepts the same fields as Create a policy. 
curl --request PUT \
  --url https://your-api-domain.com/api/v1/sla-policies/sla_abc123 \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Critical Outage SLA v2",
    "priority": "CRITICAL",
    "responseTimeMinutes": 10,
    "responseThreshold": 95,
    "resolveTimeMinutes": 45,
    "resolveThreshold": 90,
    "escalationContact": "Tier1",
    "applicableTeam": "oncall@example.com",
    "uptimeTarget": 99.99
  }'

​
Delete a policy

DELETE https://your-api-domain.com/api/v1/sla-policies/:id Permanently removes an SLA policy. Incidents already evaluated against this policy retain their recorded breach status.

​
Path parameters

​
id
string
required
The unique identifier of the SLA policy to delete.
curl --request DELETE \
  --url https://your-api-domain.com/api/v1/sla-policies/sla_abc123 \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
Breach status values

The breachStatus field on each policy reflects the current compliance state across all incidents evaluated against that policy.
ValueMeaning
NONENo active breaches detected.
RESPONSE_BREACHAt least one incident exceeded the response time target.
RESOLVE_BREACHAt least one incident exceeded the resolution time target.
BOTHIncidents breaching both response and resolution thresholds exist.