v1

latestOpenAPI 3.1.0Apache 2.02026-07-2685126228.9 KB
SLOs

Create an SLO

Create an SLO on the provided dataset.

post/1/slos/{datasetSlug}

Request body

idstring
namestring required

The name of the SLO.

descriptionstring

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

time_period_daysinteger required

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

target_per_millioninteger required

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

reset_atstring date-time nullable

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

created_atstring date-time

The ISO8601-formatted time when the SLO was created.

updated_atstring date-time

The ISO8601-formatted time when the SLO was updated.

Example request

{
  "name": "My SLO",
  "description": "SLO to ensure requests succeed and are fast",
  "sli": {
    "alias": "error_sli"
  },
  "time_period_days": 30,
  "target_per_million": 990000,
  "tags": [
    {
      "key": "team",
      "value": "blue"
    }
  ],
  "reset_at": "2022-011-11T09:53:04Z",
  "created_at": "2022-09-22T17:32:11Z",
  "updated_at": "2022-10-31T15:08:11Z",
  "dataset_slugs": [
    "mydataset1",
    "mydataset2"
  ]
}

Response

Success - SLO created

idstring
namestring required

The name of the SLO.

descriptionstring

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

time_period_daysinteger required

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

target_per_millioninteger required

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

reset_atstring date-time nullable

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

created_atstring date-time

The ISO8601-formatted time when the SLO was created.

updated_atstring date-time

The ISO8601-formatted time when the SLO was updated.

Example response

{
  "name": "My SLO",
  "description": "SLO to ensure requests succeed and are fast",
  "sli": {
    "alias": "error_sli"
  },
  "time_period_days": 30,
  "target_per_million": 990000,
  "tags": [
    {
      "key": "team",
      "value": "blue"
    }
  ],
  "reset_at": "2022-011-11T09:53:04Z",
  "created_at": "2022-09-22T17:32:11Z",
  "updated_at": "2022-10-31T15:08:11Z",
  "dataset_slugs": [
    "mydataset1",
    "mydataset2"
  ]
}