API Endpoints for SLO Annotations

Reading time: 0 minute(s) (0 words)

Using Nobl9 REST API, users can create new annotations, fetch existing ones, or delete them. You can find more detailed information on SLO Annotations in the respective section of Nobl9 documentation.

Nobl9 API has been designed to make it convenient for admins to programmatically connect their tools (e.g. for CI/CD) to Nobl9 and automate annotating SLOs (for example, during deployments). It’s a standard REST API with GET, POST, PUT, and DELETE commands available for use.

Common headers

Header	Description
Accept	Nobl9 supports application/json with an optional variable version which, for the time being, can only take one value (v1alpha). Nobl9 API does not support csv syntax. Passing (curl syntax) -H 'Accept: application/json, application/xml' will return the following error: application/json, application/xml is interpreted as a single header value.
Organization	Your organization ID. You can find it in the Nobl9 UI, in the Settings > Account. See the note below for details.
Project	The name of the Project found in /catalog/projects or through the sloctl command sloctl get projects. In most instances, you can also provide a wildcard with *. Project: * acts similarly to the sloctl command sloctl get ${resource_name} -A that searches through all Projects.
Authorization	Takes the following syntax: Bearer ${access_token} Note that syntax differs for generating access token. See the Generate Access Token section below for more details.

Access Token

The Nobl9 API endpoint for SLO Annotations requires an access token. This enables you to secure your web server's URLs so that only you and Nobl9 have access to them. The access token consists of your Client ID and Client Secret. For details on how to generate your credentials, go here.

note

You can retrieve your Organization ID in the Nobl9 UI, in the Settings > Account:

Generate Access Token

POST /api/accessToken

• Example request:

  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}"

• Headers

  Header	Mandatory?
  Accept	No
  Authorization	Yes. Use the following syntax: Basic base64enc(${clientId}:${clientSecret}).
  Organization	Yes

  tip

  We recommend downloading your token once and reusing it in your CI/CD pipeline. Generating multiple tokens may exceed your rate limits. For more details, refer to the Rate Limits section.

Annotations

Get Annotations

Fetch Annotations that have the values specified in a request.

GET /api/annotations

Example request:

curl -X GET https://app.nobl9.com/api/annotations?from=2021-12-07T08:00:00Z&to=2021-12-08T13:00:00Z&name=my-annotation-1&name=my-annotation-2&slo=my-slo' -H 'Accept: application/json; version=v1alpha' -H 'Organization: nobl9-dev' -H 'Project: *' -H "Authorization: Bearer ${access_token}"

• Example response:

  [
      {
          "name": "my-annotation-1",
          "project": "my-project-2",
          "slo": "my-slo",
          "description": "this is my first annotation",
          "objectiveName": "objective-1",
          "startTime": "2021-12-08T12:20:00Z",
          "endTime": "2021-12-08T12:20:00Z",
          "status": {
              "updatedAt": "2021-12-09T16:36:35.298419Z"
          }
      },
      {
          "name": "my-annotation-1",
          "project": "my-project-2",
          "slo": "my-slo",
          "description": "this is my second annotation",
          "objectiveName": "objective-1",
          "startTime": "2021-12-08T12:30:00Z",
          "endTime": "2021-12-08T12:30:00Z",
          "status": {
              "updatedAt": "2021-12-10T12:54:48.93971Z"
          }
      }
  ]

• Parameters:

  Parameter	Description
  slo	The name of the SLO to which the annotations are attached.
  name	The name of the annotation. You can provide multiple names. The query matches all the names, just as in the example above (name=my-annotation-1&name=my-annotation-2).
  objectiveName	Optional, the name of the Objective to which the annotations are attached.
  from	Start time of the Annotation period in RFC3339 format.
  to	End time of the Annotation period in RFC3339 format.

• Headers:

  Header	Mandatory?
  Accept	No
  Authorization	Yes
  Organization	Yes
  Project	Yes

Create Annotations

Create a new Annotation for any event within one of your SLOs.

POST /api/annotations

• Example request:

  curl -X POST https://app.nobl9.com/api/annotations -H 'Accept: application/json; version=v1alpha' -H 'Organization: my-org' -H "Authorization: Bearer ${access_token}" -d "@create.json"

• Example body:

  {
      "name": "my-annotation",
      "project": "my-project",
      "slo": "my-slo",
      "description": "this is my annotation",
      "objectiveName": "objective-1",
      "startTime": "2021-12-08T12:20:00Z",
      "endTime": "2021-12-08T12:20:00Z"
  }

• JSON object keys:

  Parameter	Description
  slo	The name of the SLO to which the annotations are attached.
  project	String, must conform to DNS (RFC 1123 format).
  name	String, must conform to DNS (RFC 1123 format).
  objectiveName	Optional, the name of the Objective to which the annotations are attached.
  from	Start time of the Annotation period in RFC3339 format.
  to	End time of the Annotation period in RFC3339 format.

• Example response:

  {
      "name": "my-annotation",
      "project": "my-project",
      "slo": "my-slo",
      "description": "this is my annotation",
      "objectiveName": "objective-1",
      "startTime": "2021-12-08T12:20:00Z",
      "endTime": "2021-12-08T12:20:00Z",
      "status": {
          "updatedAt": "2021-12-09T16:36:35.298419Z"
      }
  }

• Headers:

  Header	Mandatory?
  Accept	No
  Authorization	Yes
  Organization	Yes

Update Annotations

You can update Annotations using a standard PUT request. This method will create a new annotation unless the annotation with the provided name (i.e. specified in the body of the JSON object) does not exist in the specified Project.

In addition, you must also provide all the remaining parameters even if you want to update just one of them (effectively, this command acts like a REPLACE command).

PUT /api/annotations/{name}

note

name string - is a URL path variable that must conform to DNS (RFC 1123 format).

• Example request:

  curl -X PUT https://app.nobl9.com/api/annotations/my-annotation -H 'Accept: application/json; version=v1alpha' -H 'Organization: my-org' -H "Authorization: Bearer ${access_token}"

• Example body:

  {
      "project": "my-project",
      "slo": "my-slo",
      "description": "this is my annotation",
      "objectiveName": "objective-1",
      "startTime": "2021-12-08T12:20:00Z",
      "endTime": "2021-12-08T12:20:00Z"
  }

• JSON object keys:

  Object	Mandatory?	Description
  project	Yes	String, must conform to DNS (RFC 1123 format).
  slo	Yes	The name of the SLO to which the Annotation is attached.
  description	Yes	String, can contain up to 1000 characters.
  objectiveName	No	Optional, the name of the Objective to which the annotations are attached.
  startTime	Yes	Start time of the Annotation period in RFC3339 format.
  endTime	Yes	End time of the Annotation period in RFC3339 format.

• Example response:

  {
      "name": "my-annotation",
      "project": "my-project",
      "slo": "my-slo",
      "description": "this is my annotation",
      "objectiveName": "objective-1",
      "startTime": "2021-12-08T12:20:00Z",
      "endTime": "2021-12-08T12:20:00Z",
      "status": {
          "updatedAt": "2021-12-09T16:36:35.298419Z"
      }
  }

• Headers:

  Header	Mandatory?
  Accept	No
  Authorization	Yes
  Organization	Yes

Remove Annotations

DELETE /api/annotations/{name}

Example request:

curl -X DELETE https://app.nobl9.com/api/annotations/my-annotation -H 'Accept: application/json; version=v1alpha' -H 'Organization: my-org' -H 'Project: my-project' -H "Authorization: Bearer ${access_token}"

• Headers:

  Header	Mandatory?
  Accept	No
  Authorization	Yes
  Organization	Yes
  Project	Yes

note

Only Organization Admins can delete system annotations, for example, when a false alert was triggered. Users with other permissions can only view system annotations.

Annotations Quota and Rate Limits

A quota limits the number of user annotations - there is a limit of 100 000 annotations per organization.

note

System annotations are not counted in the annotations quota.

All requests to the endpoint https://app.nobl9.com/api/accessToken are rate limited. An organization can make 10 requests per minute - 1 request per 6 seconds. The API returns the 429 HTTP status code when this limit is exceeded.