Skip to main content
GET
Get SLO by id or key, with latest burn event

Authorizations

Authorization
string
header
required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.

Scopes

read:slos

Path Parameters

id
string
required

The SLO's id, or its key in config documents (its config_key, or the key config export gives one made in the console).

Response

ok

id
string<uuid>
required
name
string
required
service_id
string<uuid>
required
metric_def_id
string<uuid>
required
target_pct
required
window_days
integer
required
public
boolean
required
created_at
string<date-time>
required
unknown_policy
enum<string>

How unobserved periods count toward the budget: down (silence counts against the SLA, default), exclude (silence drops from the calculation; monitoring coverage is disclosed on reporting surfaces), up (silence counts as up).

Available options:
down,
exclude,
up
maintenance_policy
enum<string>

What published, scheduled maintenance on the SLO's service does to the error budget: exclude (samples inside the window leave the calculation, so maintenance pauses the budget and never opens a burn event; default) or count (maintenance burns budget like any other sample).

Available options:
exclude,
count
error_budget_remaining_pct
last_evaluated_at
string<date-time> | null
config_key
string | null

The SLO's key in config documents (null for one made in the console and never applied from config). Per-key DELETE takes this.

managed_by
enum<string>

config: owned by config apply (prune and per-key delete may remove it). console: made in the console; config apply adopts it when a document names it.

Available options:
config,
console
suspended
boolean

true while the SLO is suspended because the organization is over its plan's limit (after a 7-day grace). Nothing is deleted; it is read-only until the person chooses it as active in Billing or upgrades. Writes return 403 item_suspended_plan.

suspended_at
string<date-time> | null

When the suspension started.

latest_burn_event
object | null
updated_at
string<date-time>
key
string

The SLO's key in config documents: its config_key, or the key config export gives a console SLO. PUT /slos/{key} takes it.

service
string

The key of the SLO's service (its config_key, or the key config export gives a console service).

metric
string

The key of the metric the SLO measures (its config_key, or the key config export gives a console metric).