Public REST/JSON reference

Error Budget API

Define SLOs (target percentage + window in days + SLI query against your metric source), continuously compute the budget remaining, surface burn-rate over 1h/6h/24h windows, and project the date the budget will hit zero given the current burn rate. Page on fast-burn / slow-burn / budget-low / budget-exhausted thresholds. Part of the Logic Igniter Developer & DevOps bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/errorbudget.json

Operations rendered

Response models rendered

GET/api/v1/errorbudget/health

Service liveness

Liveness probe — returns 200 if the service is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/errorbudget/customers

List customers

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CustomersResponse

Page of customers

401Error

Missing or invalid API key.

POST/api/v1/errorbudget/customers

Provision a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CreateCustomerRequest

Sample JSON payload for evaluation.

{
  "email": "[email protected]",
  "name": "Example Inc."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/errorbudget/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Example Inc."}'

Responses

201Customer

Customer created or returned

400Error

Invalid email or missing name

401Error

Missing or invalid API key.

GET/api/v1/errorbudget/customers/{id}

Get a customer by id

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200Customer

Customer record

401Error

Missing or invalid API key.

404Error

Customer not found

PUT/api/v1/errorbudget/customers/{id}

Update a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string (uuid)

Request body (required)

Schema: UpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/errorbudget/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200Customer

Updated customer

400Error

Invalid update

401Error

Missing or invalid API key.

404Error

Customer not found

GET/api/v1/errorbudget/slos

List SLOs

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/slos" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SLOsResponse

All defined SLOs for the workspace

401Error

Missing or invalid API key.

POST/api/v1/errorbudget/slos

Define an SLO

Create a new SLO with a target percentage, window in days, and an SLI query against your metric source (e.g. Prometheus, CloudWatch, Datadog). The query is evaluated continuously to compute budget consumption.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: DefineSLORequest

Sample JSON payload for evaluation.

{
  "name": "checkout-availability",
  "target_pct": 99.9,
  "window_days": 30,
  "sli_query": "sum(rate(http_requests_total{path=\"/checkout\",code!~\"5..\"}[5m])) / sum(rate(http_requests_total{path=\"/checkout\"}[5m]))",
  "metric_source": "prometheus"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/errorbudget/slos" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"checkout-availability","target_pct":99.9,"window_days":30,"sli_query":"sum(rate(http_requests_total{path=\"/checkout\",code!~\"5..\"}[5m])) / sum(rate(http_requests_total{path=\"/checkout\"}[5m]))","metric_source":"prometheus"}'

Responses

201SLO

SLO created

400Error

Invalid target_pct, window_days, or unparseable SLI query

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers 1 SLO with daily evaluation; paid plans unlock unlimited SLOs, sub-minute evaluation, and burn-rate alerting.

GET/api/v1/errorbudget/slos/{slo_id}

Get SLO detail

Returns the SLO with its current budget remaining and the three burn-rate windows (1h, 6h, 24h) — the same numbers your dashboard would show inline.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`slo_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/slos/:slo_id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SLODetail

SLO detail

401Error

Missing or invalid API key.

404Error

SLO not found

GET/api/v1/errorbudget/slos/{slo_id}/budget

Live budget status

Returns the percentage of budget remaining and the absolute number of budgeted minutes consumed so far in the current window.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`slo_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/slos/:slo_id/budget" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200BudgetStatus

Budget status

401Error

Missing or invalid API key.

404Error

SLO not found

GET/api/v1/errorbudget/slos/{slo_id}/budget/history

Budget history

Time-series of budget remaining and burn rate. Suitable for overlaying with a deploys/incidents annotation track.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`slo_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/slos/:slo_id/budget/history" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200BudgetHistory

History points

401Error

Missing or invalid API key.

404Error

SLO not found

GET/api/v1/errorbudget/slos/{slo_id}/burn-rate

Burn rate over 1h/6h/24h windows

Burn rate is consumption-per-window divided by budget-per-window. >1 means you'll exhaust faster than the SLO window; >2 is a fast-burn condition; <0.1 is healthy.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`slo_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/slos/:slo_id/burn-rate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200BurnRate

Burn rate windows

401Error

Missing or invalid API key.

404Error

SLO not found

GET/api/v1/errorbudget/slos/{slo_id}/exhaustion

Project budget exhaustion

Given the current burn rate, returns the projected date when the budget will hit zero. Use this to decide whether to pause shipping or accept the risk on the next deploy.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`slo_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/slos/:slo_id/exhaustion" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200ExhaustionProjection

Exhaustion projection

401Error

Missing or invalid API key.

404Error

SLO not found

PUT/api/v1/errorbudget/alerts/config

Configure alert thresholds

Set the burn-rate and budget-low thresholds for an SLO. Defaults: fast_burn 14.4 (consumes monthly budget in 30 min), slow_burn 1 (linear consumption), budget_low_pct 25.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: ConfigureRequest

Sample JSON payload for evaluation.

{
  "slo_id": "11111111-1111-1111-1111-111111111111",
  "thresholds": {
    "fast_burn_threshold": 14.4,
    "slow_burn_threshold": 1,
    "budget_low_threshold_pct": 25
  }
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/errorbudget/alerts/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"slo_id":"11111111-1111-1111-1111-111111111111","thresholds":{"fast_burn_threshold":14.4,"slow_burn_threshold":1,"budget_low_threshold_pct":25}}'

Responses

200AlertConfig

Updated config

400Error

Invalid threshold values

401Error

Missing or invalid API key.

402Error

Endpoint requires an active subscription. Free tier covers 1 SLO with daily evaluation; paid plans unlock unlimited SLOs, sub-minute evaluation, and burn-rate alerting.

404Error

SLO not found

GET/api/v1/errorbudget/alerts

List alerts

Return the workspace's burn-rate and budget alerts, paginated.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/errorbudget/alerts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200AlertsResponse

Page of alerts

401Error

Missing or invalid API key.

POST/api/v1/errorbudget/alerts/{alert_id}/ack

Acknowledge an alert

Mark an alert as acknowledged so it stops re-firing in subsequent windows.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`alert_id`required	path	string (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/errorbudget/alerts/:alert_id/ack" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200AckResult

Acknowledged

401Error

Missing or invalid API key.

404Error

Alert not found

Data models

Error

Field	Type	Notes
`error`required	string

AlertType

DefineSLORequest

Field	Type	Notes
`name`required	string
`target_pct`required	number (double)
`window_days`required	integer
`sli_query`required	string
`metric_source`required	string

SLO

Field	Type	Notes
`id`	string (uuid)
`name`	string
`target_pct`	number (double)
`window_days`	integer
`metric_source`	string

SLOsResponse

Field	Type	Notes
`items`	array<SLO>

SLODetail

Field	Type	Notes
`id`	string (uuid)
`name`	string
`target_pct`	number (double)
`budget_remaining_pct`	number (double)
`burn_rate_1h`	number (double)
`burn_rate_6h`	number (double)
`burn_rate_24h`	number (double)

BudgetStatus

Field	Type	Notes
`id`	string (uuid)
`slo_id`	string (uuid)
`budget_remaining_pct`	number (double)
`budget_consumed_minutes`	integer

BurnRate

Field	Type	Notes
`id`	string (uuid)
`slo_id`	string (uuid)
`burn_rate_1h`	number (double)
`burn_rate_6h`	number (double)
`burn_rate_24h`	number (double)

ExhaustionProjection

Field	Type	Notes
`id`	string (uuid)
`slo_id`	string (uuid)
`projected_date`	string (date-time)
`current_burn_rate`	number (double)

BudgetDataPoint

Field	Type	Notes
`budget_remaining_pct`	number (double)
`burn_rate`	number (double)
`snapshot_at`	string (date-time)

BudgetHistory

Field	Type	Notes
`id`	string (uuid)
`points`	array<BudgetDataPoint>

BurnRateAlert

Field	Type	Notes
`id`	string (uuid)
`slo_id`	string (uuid)
`alert_type`	AlertType
`burn_rate`	number (double)
`budget_remaining_pct`	number (double)
`sent_at`	string (date-time)

AlertsResponse

Field	Type	Notes
`items`	array<BurnRateAlert>
`next_page_token`	string
`total_count`	integer

AlertThresholds

Field	Type	Notes
`fast_burn_threshold`	number (double)
`slow_burn_threshold`	number (double)
`budget_low_threshold_pct`	number (double)

ConfigureRequest

Field	Type	Notes
`slo_id`required	string (uuid)
`thresholds`required	AlertThresholds

AlertConfig

Field	Type	Notes
`id`	string (uuid)
`thresholds`	AlertThresholds

AckResult

Field	Type	Notes
`success`	boolean

CreateCustomerRequest

Field	Type	Notes
`email`required	string (email)
`name`required	string

UpdateCustomerRequest

Field	Type	Notes
`email`	string (email)
`name`	string

Customer

Field	Type	Notes
`id`	string (uuid)
`email`	string (email)
`name`	string
`created_at`	string (date-time)

CustomersResponse

Field	Type	Notes
`items`	array<Customer>
`next_page_token`	string
`total_count`	integer