GET
/
v1
/
breaches
curl --request GET \
  --url https://public-api.tryriot.com/v1/breaches \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "acknowledged": 2,
      "created_at": "2024-01-13T10:00:00.000000Z",
      "criticality": "low",
      "domain": "shadow.tech",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "impacted": 5,
      "last_breached_at": "2015-01-13T10:00:00.000000Z",
      "name": "Shadow",
      "status": "active",
      "updated_at": "2024-01-13T10:00:00.000000Z",
      "warned": 3
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-item-limit
integer
default:50

Maximum number of items to return. Maximum value is 100.

Required range: 1 <= x <= 100
​
x-next-cursor
string

Pagination cursor for retrieving the next page of results. This value is obtained from the 'x-next-cursor' response header of a previous API call. The cursor should be passed unchanged to fetch next pages. See https://docs.tryriot.com/api-reference/introduction#pagination for examples.

Query Parameters

​
workspace_id
string
required

ID of the workspace for which to retrieve breaches

​
status
enum<string>[]

Filters breaches based on their status. Accepts a comma-separated string of status values. Only breaches matching the specified statuses will be included in the response.

Response

200
application/json

Breaches list

The response is of type object.