SLOs

This feature is available as part of the Honeycomb Pro and Enterprise plans.

Honeycomb SLOs allow you to define and monitor Service Level Objectives (SLOs) for your organization.

This API allows you to list, create, update, and delete SLO objects.

Authorization

The API key must have the Manage SLOs permission. Learn more about API keys here.

Create an SLO

Create an SLO on the provided dataset

Securityconfiguration_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

Request Body schema: application/json
required
name
required
string [ 1 .. 120 ] characters

The name of the SLO.

description
string [ 0 .. 1023 ] characters

A nice description of the SLO's intent and context.

required
object

Reference to the Derived Column used as the indicator of event success.

time_period_days
required
integer >= 1

The time period, in days, over which the SLO will be evaluated.

target_per_million
required
integer [ 1 .. 1000000 ]

The number of events out of one million (1,000,000) that you expected qualified events to succeed.

Responses
201

Success - SLO created

404

Not Found

422

Validation Failed

default

Error

post/1/slos/{datasetSlug}
Request samples
application/json
{
  • "name": "My SLO",
  • "description": "SLO to ensure requests succeed and are fast",
  • "sli": {
    },
  • "time_period_days": 30,
  • "target_per_million": 990000
}
Response samples
application/json
{
  • "id": "string",
  • "name": "My SLO",
  • "description": "SLO to ensure requests succeed and are fast",
  • "sli": {
    },
  • "time_period_days": 30,
  • "target_per_million": 990000,
  • "reset_at": "2022-011-11T09:53:04Z",
  • "created_at": "2022-09-22T17:32:11Z",
  • "updated_at": "2022-10-31T15:08:11Z"
}

Get all SLOs

Get all SLOs for a dataset

Securityconfiguration_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

Responses
200

Success

404

Not Found

default

Error

get/1/slos/{datasetSlug}
Request samples
Response samples
application/json
[
  • {
    }
]

Get an SLO

Get an SLO by ID.

Securityconfiguration_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

sloId
required
string

Unique identifer (ID) of the SLO.

query Parameters
detailed
boolean

Allows SLO reporting data (budget_remaining and compliance) to be returned when retrieving a single SLO.

This feature is available as part of the Honeycomb Enterprise plan.

Responses
200

Success

404

Not Found

default

Error

get/1/slos/{datasetSlug}/{sloId}
Request samples
Response samples
application/json

Get an SLO by ID

{
  • "id": "bZ1aRHAUsjG",
  • "name": "My SLO",
  • "description": "My SLO description",
  • "sli": {
    },
  • "time_period_days": 30,
  • "target_per_million": 989900,
  • "reset_at": "2022-10-15T13:53:11Z",
  • "created_at": "2022-09-15T05:39:42Z",
  • "updated_at": "2022-12-20T08:10:05Z"
}

Update an SLO

Update an SLO by specifying its ID and full SLO details.

Securityconfiguration_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

sloId
required
string

Unique identifer (ID) of the SLO.

Request Body schema: application/json
required

Partial updates are not supported.

name
required
string [ 1 .. 120 ] characters

The name of the SLO.

description
string [ 0 .. 1023 ] characters

A nice description of the SLO's intent and context.

required
object

Reference to the Derived Column used as the indicator of event success.

time_period_days
required
integer >= 1

The time period, in days, over which the SLO will be evaluated.

target_per_million
required
integer [ 1 .. 1000000 ]

The number of events out of one million (1,000,000) that you expected qualified events to succeed.

Responses
200

Success

404

Not Found

422

Validation Failed

default

Error

put/1/slos/{datasetSlug}/{sloId}
Request samples
application/json
{
  • "name": "My SLO",
  • "description": "SLO to ensure requests succeed and are fast",
  • "sli": {
    },
  • "time_period_days": 30,
  • "target_per_million": 990000
}
Response samples
application/json
{
  • "id": "string",
  • "name": "My SLO",
  • "description": "SLO to ensure requests succeed and are fast",
  • "sli": {
    },
  • "time_period_days": 30,
  • "target_per_million": 990000,
  • "reset_at": "2022-011-11T09:53:04Z",
  • "created_at": "2022-09-22T17:32:11Z",
  • "updated_at": "2022-10-31T15:08:11Z"
}

Delete an SLO

Delete an SLO by specifying its ID.

Securityconfiguration_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

sloId
required
string

Unique identifer (ID) of the SLO.

Responses
204

Success - no content

404

Not Found

default

Error

delete/1/slos/{datasetSlug}/{sloId}
Request samples
Response samples
{
  • "error": "dataset not found"
}