Skip to main content
GET
/
risks
List Risks
curl --request GET \
  --url https://api.us.chkk.io/v1/risks \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "signature": {
        "id": "<string>",
        "title": "<string>",
        "description": "<string>",
        "tags": [
          "category:guardrail"
        ]
      },
      "location": {
        "cluster": {
          "id": "<string>",
          "name": "<string>",
          "namespace": "<string>"
        }
      },
      "last_detected": "2023-11-07T05:31:56Z",
      "severity": "low"
    }
  ],
  "continuation_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

Authorization credentials supplied in the Authorization header.

Query Parameters

​
filter
string[]

List Risks matching one or more filter parameters.

  1. cluster_id:k8scl_ (required)
  2. tag:category:guardrail
  3. show_ignored:true
​
page_size
integer
default:100

Number of resources to return per page

Required range: 1 <= x <= 1000
​
continuation_token
string

Opaque token for pagination

Response

200 - application/json

Returns an array of RiskSummary objects.

​
data
object[]
required
​
continuation_token
string

Opaque token for pagination