Skip to main content
Welcome to the Chkk API — a REST interface that lets you query the Chkk resources surfaced by the Chkk Operational Safety Platform.
The v2 API is available to Enterprise customers only. Contact us to request access.

Pagination

Bulk‑fetch methods in Chkk use cursor‑based pagination. Two parameters control the flow: Typical sequence
  1. First page – Omit continuation_token (and optionally set page_size).
  2. Next page – Pass the continuation_token returned in the prior response.
  3. Done – When the response no longer includes continuation_token, you have reached the end.
Example
If page_size exceeds 1000, Chkk returns HTTP 400 with an error object.

Errors

Chkk uses standard HTTP response codes to indicate the outcome of an API request. Codes in the 2xx range indicate a successful request. Codes in the 4xx range indicate a client error, such as a missing required parameter. Codes in the 5xx range indicate a server error on Chkk’s end (these are uncommon).

API Usage Examples

The Go program below:
  1. Calls GET /risks to collect every detected Risk instance in a cluster.
  2. For each Risk, calls GET /risks/{id}/resources to enumerate affected resources.
  3. Optionally shows only the resources that live in the namespace you pass with -namespace.
  4. Prints output to stdout and writes a CSV file called risks.csv to the current working directory with the output.

Prerequisites

Example script