Breaches
Team sonar

List breaches

Lists all breaches for a workspace with their affected employees count and status.

Scopes required:

  • breaches:read
get/v1/breaches

Request

  • Base URL: https://public-api.tryriot.com
  • URL: https://public-api.tryriot.com/v1/breaches
  • Auth: API key in header x-api-key

Query parameters

cursorstring

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.

limitinteger

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

workspace_idstring uuid required

ID of the workspace for which to retrieve breaches

statusBreachStatusSchema[]

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.

Headers

x-item-limitinteger

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

x-next-cursorstring

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.

Response

Breaches list

Example response

{
  "data": [
    {
      "domain": "shadow.tech",
      "name": "Shadow"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.