Skip to main content
API docs by Redocly

Audit API (1.0.0)

The Audit API provides endpoints to retrieve detailed audit logs for Nobl9 objects and events which helps you track changes and users actions.

Enterprise

Audit log API is available only for enterprise-tier accounts.
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:
None
header Parameters
Organization
required
string

Your organization ID. You can find it in the Nobl9 UI, in the Settings > Account.

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

Get audit log for a specific object

NOTE
Currently, the endpoint only supports the slo, project and service object types for the {kind} path parameter.
path Parameters
kind
required
string
Enum: "slo" "service" "project"

The type of object for which to retrieve the audit log. Currently, only slo, service, and project are supported.

name
required
string

The name of the object.

query Parameters
event
string

The type of the event.

actorType
string

The type of the actor.

limit
integer
Default: 100

The number of items to return.

offset
integer
Default: 0

The starting point of the current page.

sortBy
string
Value: "timestamp"

Specifies the field to sort the results by.

sortOrder
string
Enum: "asc" "desc"

Determines the sorting order for the results.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "total": 0
}

Get all audit logs

query Parameters
limit
integer
Default: 100

The number of items to return.

offset
integer
Default: 0

The starting point of the current page.

sortBy
string
Value: "timestamp"

The field to sort by.

sortOrder
string
Enum: "asc" "desc"

The order to sort by.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "offset": 0,
  • "limit": 0,
  • "total": 0
}