Create an SLO

Honeycomb API (1.0.0)

The API allows programmatic management of many resources within Honeycomb.

Please report any discrepancies with actual API behavior in Pollinators Slack or to Honeycomb Support.

https://docs.honeycomb.io

Download OpenAPI description

api.json

api.yaml

Overview

E-mail support@honeycomb.io

License Apache 2.0

Servers

https://api.honeycomb.io/

https://api.eu1.honeycomb.io/

Auth

API Keys have various scopes permissions and belong to a specific Team or Environment.

Any valid Honeycomb ingest or configuration API Key will work with this endpoint. Learn more about API keys.

These endpoints can be used to validate authentication for a key, to determine what authorizations have been granted to a key, and to determine the Team and Environment that a key belongs to.

Operations

Boards

Boards are a place to pin and save useful queries and graphs you want to retain for later reuse and reference.

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

Operations

Burn Alerts

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

Burn Alerts notify you when issues impact your SLO budget. Learn more about Burn Alerts here.

This API allows you to list, create, update, and delete burn alerts.

Operations

Columns

Columns are fields in the events you send to Honeycomb.

This API allows you to list, create, update, and delete columns in a dataset.

Operations

Datasets

A Dataset represents a collection of related events that come from the same source, or are related to the same source.

This API allows you to list, create, and update datasets.

Operations

Dataset Definitions

Dataset definitions describe the fields with special meaning in the Dataset.

Refer to the Dataset Definitions documentation for more information.

Honeycomb automatically creates these Dataset definition fields when the Dataset is created. Manual creation of Dataset definitions is not needed.

Operations

Derived Columns

Derived columns allow you to run queries based on the value of an expression that is derived from the columns in an event.

This API allows you to list, create, update, and delete derived columns in a dataset or across a whole environment, paralleling the behavior of the Schema tab within a Dataset's or Environment's Settings UI.

Operations

Events

The Events API endpoints are the lowest-level way to send Events to Honeycomb. This should be your last resort!

If unsure where to start when instrumenting an application, read about how to Send Data to Honeycomb.

If you are building a tracing or metrics library, we recommend using OpenTelemetry.

Operations

Environments

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

Operations

Key Management

This API allows you to list, create, update, and delete API Keys for a Team.

Operations

Kinesis Events

The Kinesis Events API endpoints allow Honeycomb to process streaming events from Amazon Kinesis.

Refer to the Honeycomb AWS integrations documentation for more information.

Operations

Markers

Markers indicate points in time on graphs where interesting things happen, such as deploys or outages.

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

Operations

Marker Settings

Marker Settings apply to groups of similar Markers. For example, "deploys" markers appear with the same color on a graph.

This API allows you to list, create, update, and delete Marker Settings.

Operations

Queries

Queries in Honeycomb are specifications for queries, and are used to identify queries in other parts of the API - in particular: boards, triggers, and query annotations.

This API allows you to create and get query objects.

Operations

Query Annotations

Query Annotations in Honeycomb allow you to associate names and descriptions to queries to add additional information in collaboration features.

This API allows you to list, create, update, and delete Query Annotations.

Operations

Query Data

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

Query Results are the aggregated data from a Query, similar to what is displayed in graphs or heatmaps within the Honeycomb UI. Receiving results from a Query is a three-step process:

Create the Query (or Query Spec), which validates that the query parameters are valid. Creating a query does not actually run the query to get results. Run the query asynchronously by creating a Query Result referencing the Query’s ID. This returns a Query Result ID. Poll the query result endpoint (with the Query Result ID) until the data is ready.

Note that many Query Results can be created from a single Query. This is particularly useful when using a relative time_range parameter in the Query. For example, a Query with time_range: 7200 and no explicit start_time or end_time can be re-run over and over, with each resulting Query Result containing the most recent 2 hours of data. This is conceptually similar to clicking Run Query in the Honeycomb UI without changing any query parameters.

IMPORTANT API RESTRICTIONS:

To ensure the stability of Honeycomb systems, we have enabled the following API restrictions. These restrictions may change over time.

Query Results can only be created for events with timestamps within the past 7 days.
When creating a Query Result, the time ranges from the Query are truncated according to the following rules. For queries with a time range of:
- less than or equal to 6 hours, results are truncated to the nearest 1 minute. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:28:00Z.
- greater than 6 hours and less than or equal to 2 days, results are truncated to the nearest 5 minutes. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:25:00Z.
- greater than 2 days and less than or equal to 7 days, results are truncated to the nearest 30 minutes. For example, a start/end time of 2021-04-22T05:28:12Z will be truncated to 2021-04-22T05:00:00Z.
Creating a Query Result is rate limited to 10 requests per minute. Status code 429 will be returned when rate limited.
Query Results cannot take longer than 10 seconds to run.

Operations

Recipients

Honeycomb Recipients allow you to define and manage the Recipients that will get notified by a Trigger or Burn Alert.

The types of Recipients supported are: PagerDuty, Email, Webhook, Microsoft Teams, and Slack.

Operations

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.

Operations

Authorization

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

Create an SLO

Request

Create an SLO on the provided dataset

Path

datasetSlugstringrequired

The dataset slug.

Bodyapplication/jsonrequired

namestring[ 1 .. 120 ] charactersrequired

The name of the SLO.

Example: "My SLO"

descriptionstring[ 0 .. 1023 ] characters

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

Example: "SLO to ensure requests succeed and are fast"

sliobjectrequired

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

Example: {"alias":"error_sli"}

sli.aliasstring[ 1 .. 255 ] charactersrequired

The alias of the derived column.

Example: "error_sli"

time_period_daysinteger>= 1required

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

Example: 30

target_per_millioninteger[ 0 .. 999999 ]required

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

Example: 990000

curl -i -X POST \
  'https://api.honeycomb.io/1/slos/{datasetSlug}' \
  -H 'Content-Type: application/json' \
  -H 'X-Honeycomb-Team: YOUR_API_KEY_HERE' \
  -d '{
    "name": "My SLO",
    "description": "SLO to ensure requests succeed and are fast",
    "sli": {
      "alias": "error_sli"
    },
    "time_period_days": 30,
    "target_per_million": 990000
  }'

Responses

Success - SLO created

Bodyapplication/json

idstringread-only

namestring[ 1 .. 120 ] charactersrequired

The name of the SLO.

Example: "My SLO"

descriptionstring[ 0 .. 1023 ] characters

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

Example: "SLO to ensure requests succeed and are fast"

sliobjectrequired

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

Example: {"alias":"error_sli"}

sli.aliasstring[ 1 .. 255 ] charactersrequired

The alias of the derived column.

Example: "error_sli"

time_period_daysinteger>= 1required

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

Example: 30

target_per_millioninteger[ 0 .. 999999 ]required

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

Example: 990000

reset_atnull or string(date-time)read-only

The ISO8601-formatted time the SLO was last reset. The value will be null if the SLO has not yet been reset.

Example: "2022-011-11T09:53:04Z"

created_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was created.

Example: "2022-09-22T17:32:11Z"

updated_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was updated.

Example: "2022-10-31T15:08:11Z"

Response

application/json

{
  "id": "string",
  "name": "My SLO",
  "description": "SLO to ensure requests succeed and are fast",
  "sli": {
    "alias": "error_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

Request

Get all SLOs for a dataset

Path

datasetSlugstringrequired

The dataset slug.

curl -i -X GET \
  'https://api.honeycomb.io/1/slos/{datasetSlug}' \
  -H 'X-Honeycomb-Team: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [

idstringread-only

namestring[ 1 .. 120 ] charactersrequired

The name of the SLO.

Example: "My SLO"

descriptionstring[ 0 .. 1023 ] characters

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

Example: "SLO to ensure requests succeed and are fast"

sliobjectrequired

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

Example: {"alias":"error_sli"}

sli.aliasstring[ 1 .. 255 ] charactersrequired

The alias of the derived column.

Example: "error_sli"

time_period_daysinteger>= 1required

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

Example: 30

target_per_millioninteger[ 0 .. 999999 ]required

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

Example: 990000

reset_atnull or string(date-time)read-only

The ISO8601-formatted time the SLO was last reset. The value will be null if the SLO has not yet been reset.

Example: "2022-011-11T09:53:04Z"

created_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was created.

Example: "2022-09-22T17:32:11Z"

updated_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was updated.

Example: "2022-10-31T15:08:11Z"

]

Response

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 an SLO

Request

Get an SLO by ID.

Path

datasetSlugstringrequired

The dataset slug.

sloIdstringrequired

Unique identifier (ID) of the SLO.

Query

detailedboolean

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.

curl -i -X GET \
  'https://api.honeycomb.io/1/slos/{datasetSlug}/{sloId}?detailed=true' \
  -H 'X-Honeycomb-Team: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

Any of:

idstringread-only

namestring[ 1 .. 120 ] charactersrequired

The name of the SLO.

Example: "My SLO"

descriptionstring[ 0 .. 1023 ] characters

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

Example: "SLO to ensure requests succeed and are fast"

sliobjectrequired

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

Example: {"alias":"error_sli"}

sli.aliasstring[ 1 .. 255 ] charactersrequired

The alias of the derived column.

Example: "error_sli"

time_period_daysinteger>= 1required

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

Example: 30

target_per_millioninteger[ 0 .. 999999 ]required

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

Example: 990000

reset_atnull or string(date-time)read-only

The ISO8601-formatted time the SLO was last reset. The value will be null if the SLO has not yet been reset.

Example: "2022-011-11T09:53:04Z"

created_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was created.

Example: "2022-09-22T17:32:11Z"

updated_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was updated.

Example: "2022-10-31T15:08:11Z"

Response

application/json

Get an SLO by ID

{
  "id": "bZ1aRHAUsjG",
  "name": "My SLO",
  "description": "My SLO description",
  "sli": {
    "alias": "my-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

Request

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

Path

datasetSlugstringrequired

The dataset slug.

sloIdstringrequired

Unique identifier (ID) of the SLO.

Bodyapplication/jsonrequired

Partial updates are not supported.

namestring[ 1 .. 120 ] charactersrequired

The name of the SLO.

Example: "My SLO"

descriptionstring[ 0 .. 1023 ] characters

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

Example: "SLO to ensure requests succeed and are fast"

sliobjectrequired

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

Example: {"alias":"error_sli"}

sli.aliasstring[ 1 .. 255 ] charactersrequired

The alias of the derived column.

Example: "error_sli"

time_period_daysinteger>= 1required

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

Example: 30

target_per_millioninteger[ 0 .. 999999 ]required

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

Example: 990000

curl -i -X PUT \
  'https://api.honeycomb.io/1/slos/{datasetSlug}/{sloId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Honeycomb-Team: YOUR_API_KEY_HERE' \
  -d '{
    "name": "My SLO",
    "description": "SLO to ensure requests succeed and are fast",
    "sli": {
      "alias": "error_sli"
    },
    "time_period_days": 30,
    "target_per_million": 990000
  }'

Responses

Success

Bodyapplication/json

idstringread-only

namestring[ 1 .. 120 ] charactersrequired

The name of the SLO.

Example: "My SLO"

descriptionstring[ 0 .. 1023 ] characters

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

Example: "SLO to ensure requests succeed and are fast"

sliobjectrequired

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

Example: {"alias":"error_sli"}

sli.aliasstring[ 1 .. 255 ] charactersrequired

The alias of the derived column.

Example: "error_sli"

time_period_daysinteger>= 1required

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

Example: 30

target_per_millioninteger[ 0 .. 999999 ]required

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

Example: 990000

reset_atnull or string(date-time)read-only

The ISO8601-formatted time the SLO was last reset. The value will be null if the SLO has not yet been reset.

Example: "2022-011-11T09:53:04Z"

created_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was created.

Example: "2022-09-22T17:32:11Z"

updated_atstring(date-time)read-only

The ISO8601-formatted time when the SLO was updated.

Example: "2022-10-31T15:08:11Z"

Response

application/json

{
  "id": "string",
  "name": "My SLO",
  "description": "SLO to ensure requests succeed and are fast",
  "sli": {
    "alias": "error_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

Request

Delete an SLO by specifying its ID.

Path

datasetSlugstringrequired

The dataset slug.

sloIdstringrequired

Unique identifier (ID) of the SLO.

curl -i -X DELETE \
  'https://api.honeycomb.io/1/slos/{datasetSlug}/{sloId}' \
  -H 'X-Honeycomb-Team: YOUR_API_KEY_HERE'

Responses

Success - no content

Response

{
  "error": "unknown API key - check your credentials"
}

Triggers

Triggers let you receive notifications when your data in Honeycomb crosses the thresholds that you configure. The graph on which to alert is as flexible as a Honeycomb query, which helps reduce false positives due to known errors.Triggers fire

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

Operations

Errors

The Honeycomb API returns standardized error responses, as documented here.

Honeycomb API (1.0.0)

Auth

Boards

Burn Alerts

Columns

Datasets

Dataset Definitions

Derived Columns

Events

Environments

Key Management

Kinesis Events

Markers

Marker Settings

Queries

Query Annotations

Query Data

Recipients

SLOs

Authorization

Create an SLO

RequestExpand all

Responses

Was this helpful?

Get all SLOs

Request

Responses

Was this helpful?

Get an SLO

Request

Responses

Was this helpful?

Update an SLO

RequestExpand all

Responses

Was this helpful?

Delete an SLO

Request

Responses

Was this helpful?

Triggers

Errors

Request

Request