Find monitor by search terms and filters

List Monitors given the provided search terms and filters

Securitybearer
Request
query Parameters
page
number >= 1
Default: 1

Which page of data are you requesting

limit
number [ 1 .. 50 ]
Default: 20

How many items are you requesting

q
string

Filter data by searching for test names

Example: q=SSL enforced on company website
checkResultStatus
string

Filter monitors (control test instances) on a result status

Enum: "READY" "PASSED" "FAILED" "ERROR" "PREAUDIT"
Example: checkResultStatus=ERROR
checkResultStatuses
Array of strings

Filter monitors (control test instances) on result statuses

Items Enum: "READY" "PASSED" "FAILED" "ERROR" "PREAUDIT"
Example: checkResultStatuses=PASSED&checkResultStatuses=FAILED
checkStatus
string

Filter monitors (control test instances) on system status

Enum: "UNUSED" "UPCOMING" "ENABLED" "DISABLED" "TESTING"
Example: checkStatus=ENABLED
source
string

Filter monitors by test source type (control test instances)

Enum: "DRATA" "CUSTOM" "EXTERNAL" "ACORN"
Example: source=DRATA
type
string

Filter monitors by check type (associated monitor instances)

Enum: "POLICY" "IN_DRATA" "AGENT" "INFRASTRUCTURE" "VERSION_CONTROL" "IDENTITY" "TICKETING" "HRIS" "OBSERVABILITY"
Example: type=INFRASTRUCTURE
controlOwner
number

Owner id to filter against

Example: controlOwner=1
getAll
boolean

boolean for running through the full pagination

Example: getAll=true
includeArchivedControls
boolean

boolean for getting archived controls as well

Example: includeArchivedControls=true
controlId
number

Control id to filter against

Example: controlId=1
excludeControlId
number

Control id to filter against

Example: excludeControlId=1
excludeTestIds
Array of numbers

Exclude tests by array of id

Example:
sortByName
boolean

boolean for sorting results by name

Example: sortByName=true
reportInterval
string

The interval to group the data on

Enum: "WEEKLY" "MONTHLY"
Example: reportInterval=MONTHLY
drafts
boolean

boolean for returning drafts instead of published

Example: drafts=true
Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

500

Internal server error

default

Response Code: 412

You must accept the Drata terms and conditions to use the API

get/public/monitors
Request samples
Response samples
application/json
{
  • "data": [
    • { }
    ],
  • "page": 1,
  • "limit": 10,
  • "total": 100
}