Monitor Instances

Find monitor by search terms and filters

List Monitors given the provided search terms and filters

🔒 Requires Monitoring: List Monitors permission.

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" "NEW" "ENABLED" "DISABLED" "TESTING" Example: checkStatus=ENABLED
source	string Filter monitors by test source type (control test instances) Enum: "DRATA" "CUSTOM" "EXTERNAL" "ACORN" "DRATA_LIBRARY" 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" "CUSTOM" 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

412

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

500

Internal server error

get/monitors

Request samples

Response samples

application/json

{"data": [{"id": 1,
"name": "A Version Control System is being Used",
"description": "Inspected Drata's version control system...",
"checkResultStatus": "PASSED",
"lastCheck": "2025-07-01T16:45:55.246Z",
"checkStatus": "ENABLED",
"disabledMessage": "Disabled since it is not applicable to the company",
"priority": "NORMAL",
"autoEnabledAt": "2025-07-01T16:45:55.246Z",
"testId": "42",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z",
"monitorInstances": "MonitorInstanceResponseDto[]",
"disablingUser": {"id": 1,
"entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
"email": "[email protected]",
"firstName": "Sally",
"lastName": "Smith",
"jobTitle": "CEO",
"avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
"drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z",
"roles": ["ROLE",
"ANOTHER_ROLE"
],
"backgroundChecks": [{"id": 1,
"userId": 1,
"status": "OK",
"caseId": "abc123",
"caseInvitationId": "abc123",
"url": "https://app-stage.karmacheck.com/background_check/aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
"manualCheckDate": "2020-07-06",
"manuallyCheckUrl": "url.com",
"type": "CERTN",
"source": "DRATA",
"reportData": "string",
"user": { },
"outOfScopeReason": "abc123",
"outOfScopeAt": "2025-07-01T16:45:55.246Z",
"invitationEmail": "[email protected]",
"linkedAt": "2025-07-01T16:45:55.246Z",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z"
}
],
"identities": [{"id": 1,
"identityId": "1a2b3c",
"username": "Username",
"connectedAt": "2025-07-01T16:45:55.246Z",
"disconnectedAt": "2025-07-01T16:45:55.246Z",
"hasMfa": true,
"user": { },
"connection": {"id": "1",
"clientType": "GOOGLE",
"state": "ACTIVE",
"connected": false,
"connectedAt": "2025-07-01T16:45:55.246Z",
"failedAt": "2025-07-01T16:45:55.246Z",
"companyId": "12341234",
"assignmentId": "FLk12AsS",
"user": { },
"accountId": "string",
"clientId": "abc123",
"clientAlias": "My-connection-alias-1",
"manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
"aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
"deletedAt": "2025-07-01T16:45:55.246Z",
"requestorId": "328d3016-71f3-4485-af20-06ce8044da18",
"product": { },
"writeAccessEnabled": false,
"sourcePreference": "LABEL",
"securityLabel": "Jira Security Label",
"jqlQuery": "project = IT AND type = \"Offboarding\"",
"authorized": true,
"workspaces": [{"id": 1,
"name": "Drata",
"description": "Platform to track SOC 2 compliance within the organization",
"howItWorks": null,
"url": "https://app.drata.com",
"logo": "https://cdn.drata.com/icon/icon_fwhite_bblue_256.png",
"primary": true
}
],
"providerTypes": [5
],
"code": 10010,
"groupLabel": "Everyone"
},
"hasIdp": true,
"secondaryEmail": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"startedAt": "2025-07-01T16:45:55.246Z",
"separatedAt": "2025-07-01T16:45:55.246Z",
"isContractor": true,
"jobTitle": "Engineer",
"managerId": "x00jk12-2312",
"managerName": "string"
}
],
"documents": [{"data": [{"id": null,
"name": null,
"type": null,
"fileUrl": null,
"renewalDate": null,
"createdAt": null,
"updatedAt": null
}
],
"page": 1,
"limit": 10,
"total": 100
}
]
},
"controls": "ControlMonitorResponseDto[]",
"monitorInstanceExclusions": "ExclusionDto[]",
"graph": "ControlTestInstanceHistoryType",
"eventTypes": ["COMPANY_DATA_UPDATED"
]
}
],
"page": 1,
"limit": 10,
"total": 100
}

Find monitor details by test id

Get details for a monitor

🔒 Requires Monitoring: Get Monitor permission.

Securitybearer

Request

path Parameters

testId required	number
workspaceId required	number The Workspace ID associated to the Account

Responses

200

400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

404

Not Found

412

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

500

Internal server error

get/workspaces/{workspaceId}/monitors/{testId}/details

Request samples

Response samples

application/json

{"id": 1,
"name": "A Version Control System is being Used",
"description": "Inspected Drata's version control system...",
"checkResultStatus": "PASSED",
"lastCheck": "2025-07-01T16:45:55.246Z",
"checkStatus": "ENABLED",
"disabledMessage": "Disabled since it is not applicable to the company",
"priority": "NORMAL",
"autoEnabledAt": "2025-07-01T16:45:55.246Z",
"testId": "42",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z",
"monitorInstances": "MonitorInstanceResponseDto[]",
"disablingUser": {"id": 1,
"entryId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
"email": "[email protected]",
"firstName": "Sally",
"lastName": "Smith",
"jobTitle": "CEO",
"avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
"drataTermsAgreedAt": "2025-07-01T16:45:55.246Z",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z",
"roles": ["ROLE",
"ANOTHER_ROLE"
],
"backgroundChecks": [{"id": 1,
"userId": 1,
"status": "OK",
"caseId": "abc123",
"caseInvitationId": "abc123",
"url": "https://app-stage.karmacheck.com/background_check/aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
"manualCheckDate": "2020-07-06",
"manuallyCheckUrl": "url.com",
"type": "CERTN",
"source": "DRATA",
"reportData": "string",
"user": { },
"outOfScopeReason": "abc123",
"outOfScopeAt": "2025-07-01T16:45:55.246Z",
"invitationEmail": "[email protected]",
"linkedAt": "2025-07-01T16:45:55.246Z",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z"
}
],
"identities": [{"id": 1,
"identityId": "1a2b3c",
"username": "Username",
"connectedAt": "2025-07-01T16:45:55.246Z",
"disconnectedAt": "2025-07-01T16:45:55.246Z",
"hasMfa": true,
"user": { },
"connection": {"id": "1",
"clientType": "GOOGLE",
"state": "ACTIVE",
"connected": false,
"connectedAt": "2025-07-01T16:45:55.246Z",
"failedAt": "2025-07-01T16:45:55.246Z",
"companyId": "12341234",
"assignmentId": "FLk12AsS",
"user": { },
"accountId": "string",
"clientId": "abc123",
"clientAlias": "My-connection-alias-1",
"manuallyUpdatedAt": "2025-07-01T16:45:55.246Z",
"aliasUpdatedAt": "2025-07-01T16:45:55.246Z",
"deletedAt": "2025-07-01T16:45:55.246Z",
"requestorId": "328d3016-71f3-4485-af20-06ce8044da18",
"product": { },
"writeAccessEnabled": false,
"sourcePreference": "LABEL",
"securityLabel": "Jira Security Label",
"jqlQuery": "project = IT AND type = \"Offboarding\"",
"authorized": true,
"workspaces": [{"id": 1,
"name": "Drata",
"description": "Platform to track SOC 2 compliance within the organization",
"howItWorks": null,
"url": "https://app.drata.com",
"logo": "https://cdn.drata.com/icon/icon_fwhite_bblue_256.png",
"primary": true
}
],
"providerTypes": [5
],
"code": 10010,
"groupLabel": "Everyone"
},
"hasIdp": true,
"secondaryEmail": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"startedAt": "2025-07-01T16:45:55.246Z",
"separatedAt": "2025-07-01T16:45:55.246Z",
"isContractor": true,
"jobTitle": "Engineer",
"managerId": "x00jk12-2312",
"managerName": "string"
}
],
"documents": [{"data": [{"id": 1,
"name": "Security Training",
"type": "SEC_TRAINING",
"fileUrl": "http://localhost:5000/download/documents/1",
"renewalDate": "2026-10-27",
"createdAt": "2025-07-01T16:45:55.246Z",
"updatedAt": "2025-07-01T16:45:55.246Z"
}
],
"page": 1,
"limit": 10,
"total": 100
}
]
},
"controls": "ControlMonitorResponseDto[]",
"monitorInstanceExclusions": "ExclusionDto[]"
}

Get Monitor failed Test results

🔒 Requires Monitoring: Get Monitor permission.

Securitybearer

Request

path Parameters

workspaceId required	number The Workspace ID associated to the Account
testId required	number

query Parameters

type required	string Filter monitors by included or excluded Enum: "included" "excluded" Example: type=included
checkType	string Filter monitors by check type Enum: "POLICY" "IN_DRATA" "AGENT" "INFRASTRUCTURE" "VERSION_CONTROL" "IDENTITY" "TICKETING" "HRIS" "OBSERVABILITY" "CUSTOM" Example: checkType=INFRASTRUCTURE

Responses

200

Successful

get/workspaces/{workspaceId}/monitors/{testId}/failures

Request samples

Response samples

{"data": [{"organizationalUnitId": "ou-1001",
"accountId": "123456789012",
"accountName": "test-mgmt",
"providerName": "AWS",
"clientId": 259468815732,
"clientAlias": "test-mgmt",
"id": "AIDATY2ML5V2DQJUJ6TYY / us-west-2 / 259468815732",
"resourceName": "TestUser",
"displayName": "TestUser / us-west-2 / 259468815732",
"resourceArn": "arn:aws:iam::259468815732:user/TestUser",
"cause": [{"fact": "passwordPolicy",
"path": "MinimumPasswordLength",
"value": 14,
"operator": "greaterThanOrEqual",
"result": false,
"factResult": 8
}
],
"associatedHelpArticle": "https://help.drata.com/en/articles/4778759-test-storage-data-versioned-or-retained",
"failingMessage": "string"
}
]
}