Skip to main content
API docs by Redocly

Nobl9 SLO Status API 2.0 (2.0.0)

NOTE
While we encourage transitioning to version 2.0, please note that the version 1.0 will remain supported for the foreseeable future.

With Nobl9 SLO Status API, you can easily access the most up-to-date metrics for any SLO you need.

This gives you the ability to use your SLO data in a variety of automated tools (CI/CD pipelines) or applications (external dashboards).

Leveraging SLO Status API can save you time and help streamline your workflow, giving you more time to focus on other important tasks.

Rate Limits for SLO Status API

All requests to the endpoint /api/v1/slos are rate limited. An organization can make up to 10 requests per seconds.

The API returns the 429 HTTP status code when this limit is exceeded.

Scroll down to see code samples

Access Token

Generate access token

To generate access token, you must provide Authorization header with the Basic scheme.

The access token consists of your Client ID and Client Secret in the following format: clientId:clientSecret.

Rate Limits for access token

All requests to the endpoint /api/accessToken are rate limited. An organization can make 1 request per 3 seconds.

The API returns the 429 HTTP status code when this limit is exceeded.

NOTE
Your token will be valid for 1 hour. Minimize the usage of this endpoint and reuse the token until it expires.

We recommend downloading your token once and reusing it in your CI/CD pipeline. Generating multiple tokens may exceed your rate limits.

Authorizations:
basicAuth
header Parameters
Organization
required
string

ID of your organization.

Responses

Request samples 

curl -X \
POST https://app.nobl9.com/api/accessToken -H 'Accept: application/json; version=v1alpha' \
-H 'Organization: nobl9-dev' \
-H 'Authorization: Basic ${encoded_access_keys}'

Response samples

Content type
application/json
{
  • "access_token": "string"
}

SLO

List SLOs

Return a SLO list for a specific organization

Authorizations:
bearerAuth
query Parameters
limit
integer

Specifies the number of returned results (maximum of 500 items).

cursor
string

Specifies the pagination cursor for the next page of results. You can get it through the next link property.

header Parameters
Organization
required
string

ID of your organization.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    }
}

Find SLO by name

Returns a single SLO

Authorizations:
bearerAuth
path Parameters
sloName
required
string <= 63 characters

Name of the SLO to return.

query Parameters
fields
string
Example: fields=counts

Use to request for additional metrics, such as aggregated good and total counts.
Currently supported counts, which returns the total and good counts for each of the SLO's objective.
To specify the range of data to be gathered, use to and from query parameters (e.g., from=2021-01-01T00:00:00Z&to=2021-01-02T00:00:00Z).

from
string <date-time>
Example: from=2024-01-25T23:00:00Z

Specifies the start date and time for the data range (in UTC). Required when using the fields and to parameter.
The API allows to retrieve 7 days of data.

to
string <date-time>
Example: to=2024-01-25T23:59:00Z

Specifies the end date and time for the data range (in UTC). Required when using the fields and from parameter.
The API allows to retrieve 7 days of data.

header Parameters
Organization
required
string

ID of your organization.

project
required
string

Filters results by a specific project.

Responses

Response samples

Content type
application/json
{
  • "name": "sample-latency-slo",
  • "displayName": "Sample latency SLO",
  • "description": "This is a sample latency SLO",
  • "project": {
    },
  • "service": {
    },
  • "objectives": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "composite": {
    },
  • "labels": {
    },
  • "annotations": {
    },
  • "budgetingMethod": "Occurrences"
}