MarBoba
Sign in

SLOs REST endpoints

Generated

6 endpoints under `/v1`.

Auto-generated from the MarBoba OpenAPI spec, published at api.marboba.com/v1/openapi.json.

GET /slos

List SLOs

Lists every SLO in the calling token’s org. Optional query filters: appId, status, type.

Parameters

NameInTypeRequiredDescription
appIdquerystringoptional
statusqueryenum (met / atRisk / breached)optional
typequeryenum (availability / latency / errorRate / throughput / custom)optional

Responses

  • 200 — List of SLOs. Body: object
  • 401 — . Body: (no body)

Auth: BearerPAT

Operation ID: get_slos

POST /slos

Create an SLO

Request body

Request body (application/json): SloInput

Responses

  • 201 — Created. Body: object
  • 400 — . Body: (no body)

Auth: BearerPAT

Operation ID: post_slos

DELETE /slos/{sloId}

Delete an SLO

Cascade-deletes the SLO’s snapshot history. Requires admin scope (PAT only).

Responses

  • 204 — Deleted. Body: (no body)
  • 403 — . Body: (no body)
  • 404 — . Body: (no body)

Auth: BearerPAT

Operation ID: delete_slos-sloid

GET /slos/{sloId}

Get an SLO

Responses

  • 200 — The requested SLO. Body: object
  • 404 — . Body: (no body)

Auth: BearerPAT

Operation ID: get_slos-sloid

PATCH /slos/{sloId}

Update an SLO

Mutable fields: name, target, type, window, unit, dataSource, currentValue. Changing type, target, or window resets the error budget — the sloCalculator will refine the next recalculation.

Request body

Request body (application/json): SloInput

Responses

  • 200 — Updated. Body: object
  • 400 — . Body: (no body)
  • 404 — . Body: (no body)

Auth: BearerPAT

Operation ID: patch_slos-sloid

GET /slos/{sloId}/snapshots

Get an SLO’s burn-down history

Returns up to limit snapshots in ascending takenAt order. The sloCalculator writes one snapshot per SLO every 15 minutes, so the default 500-snapshot limit covers ~5 days of history. Use this to power a burn-down chart in your dashboard.

Responses

  • 200 — List of snapshots. Body: object
  • 404 — . Body: (no body)

Auth: BearerPAT

Operation ID: get_slos-sloid-snapshots