Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb SLOs API

This feature is available as part of the [Honeycomb Pro and Enterprise plans](https://www.honeycomb.io/pricing).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.You can also access historical reporting for your SLOs to analyze long-term performance trends. For more information, see [Get SLO History](https://api-docs.honeycomb.io/api/reporting/getslohistory)## AuthorizationThe API key must have the **Manage SLOs** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

Honeycomb SLOs API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SLOs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

7 operations 4 paths 12 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

SLOs 7

This feature is available as part of the [Honeycomb Pro and Enterprise plans](https://www.honeycomb.io/pricing). Honeycomb SLOs allow you to define and monitor Service Level Objec…

POST
/1/slos/{datasetSlug}
Create an SLO
createSlo 1 param body → 201401403404422429default
GET
/1/slos/{datasetSlug}
Get all SLOs
listSlos 1 param → 200401403404429default
GET
/1/slos/{datasetSlug}/{sloId}
Get an SLO
getSlo 3 params → 200401403404429default
PUT
/1/slos/{datasetSlug}/{sloId}
Update an SLO
updateSlo 2 params body → 200401403404422429default
DELETE
/1/slos/{datasetSlug}/{sloId}
Delete an SLO
deleteSlo 2 params → 204401403404429default
GET
/1/slos/{datasetSlug}/{sloId}/counts
Get SLO Realtime Counts
getSloRealtimeCounts 4 params → 200400401403404429default
GET
/1/slos/{datasetSlug}/{sloId}/counts/history
Get SLO Hourly Counts History
getSloHourlyCountsHistory 4 params → 200400401403404429default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SLOCreate (11 properties), SLO (11 properties), DetailedError (6 properties), SLOCountsResponse (5 properties). Each schema is shown below with its type and property counts.

Tag
object
2 properties 2 required
SLODetailedResponse
object
4 properties
SLOHourBucket
object
5 properties
Error
object
A legacy error, containing only a textual description.
1 property
SLOCountWindow
object
5 properties
ValidationError
SLOHourlyCountsResponse
object
3 properties
SLO
object
11 properties 4 required
SLOCreate
object
11 properties 4 required
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
SLOCountsResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-slos-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Burn Alerts API
Honeycomb Calculated Fields API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API