Get a list of documents for a given device and document type
🔒 Requires Devices: Manage Device Documents permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "documents": [
- {
- "id": 1,
- "type": "PASSWORD_MANAGER_EVIDENCE",
- "name": "Password Manager Evidence",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}
]
}
Upload a new device document for a given device
🔒 Requires Devices: Manage Device Documents permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
The file was too large to upload
Internal server error
Third party system was unavailable
{- "id": 1,
- "type": "PASSWORD_MANAGER_EVIDENCE",
- "name": "Password Manager Evidence",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z"
}
Removes a specific device document using the provided document ID
🔒 Requires Devices: Manage Device Documents permission.
Successful
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
Internal server error
{- "statusCode": 0,
- "message": "string",
- "code": 0,
- "debugInfo": {
- "name": "string",
- "message": "string",
- "stack": "string"
}
}
Get device document download URL by document ID
🔒 Requires Devices: Manage Device Documents permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
Internal server error
{- "fileBuffer": {
- "buffer": "RXhhbXBsZSB0ZXh0IGNvbnRlbnQ="
}
}
🔒 Requires Devices: List Devices permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "data": [
- {
- "externalId": "3000",
- "personnelId": 206,
- "userId": 207,
- "id": 3,
- "osVersion": "MacOS 11",
- "serialNumber": "q77gfdp0xg03vcu6t1fi",
- "model": "MacBook Pro 14-in(2021)",
- "macAddress": "91:2b:4a:7a:51:73",
- "encryptionEnabled": null,
- "firewallEnabled": null,
- "gateKeeperEnabled": null,
- "lastCheckedAt": "2024-11-25T22:16:23.479Z",
- "sourceType": "AGENT",
- "createdAt": "2024-11-25T22:16:23.479Z",
- "updatedAt": "2024-12-08T22:20:15.041Z",
- "deletedAt": null,
- "appsCount": null
}, - {
- "externalId": "4000",
- "personnelId": 305,
- "userId": 306,
- "id": 4,
- "osVersion": "MacOS 12",
- "serialNumber": "locldk8eyxn28eyb3ktj",
- "model": "MacBook Pro 16-in(2021)",
- "macAddress": "0f:8a:67:b2:90:ad",
- "encryptionEnabled": null,
- "firewallEnabled": null,
- "gateKeeperEnabled": null,
- "lastCheckedAt": "2024-11-25T22:16:23.705Z",
- "sourceType": "AGENT",
- "createdAt": "2024-11-25T22:16:23.705Z",
- "updatedAt": "2024-12-08T22:20:15.041Z",
- "deletedAt": null,
- "appsCount": null
}
], - "page": 1,
- "limit": 10,
- "total": 100
}
🔒 Requires Devices: List Devices permission.
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
Internal server error
{- "id": 1,
- "osVersion": "MacOS 10.15.6",
- "serialNumber": "C02T6CDJGTFL",
- "model": "MacBook Pro",
- "macAddress": "65-F9-3D-85-7B-6B,99-A9-3E-14-7A-3E",
- "encryptionEnabled": false,
- "encryptionExplanation": "No encryption provided",
- "firewallEnabled": true,
- "firewallExplanation": "{}",
- "lastCheckedAt": "2025-07-01T16:45:55.246Z",
- "sourceType": "AGENT",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z",
- "deletedAt": "2025-07-01T16:45:55.246Z",
- "appsCount": 20,
- "complianceChecks": [ ],
- "identifiers": [ ],
- "documents": [ ],
- "isDeviceCompliant": false,
- "screenLockTime": 30,
- "screenLockExplanation": {
- "minutesIdleBeforeSleep": "2",
- "minutesSleepingBeforePasswordIsRequired": "2"
}, - "antivirusEnabled": true,
- "antivirusExplanation": "No matching app was found",
- "autoUpdateEnabled": true,
- "autoUpdateExplanation": "No compliances found",
- "passwordManagerEnabled": true,
- "passwordManagerExplanation": {
- "passwordManagerApps": [
- "1password 7"
]
}, - "asset": {
- "id": 651,
- "name": "MacBook Pro - Space Black 16-inch",
- "description": "MacBook Pro Space Black - with 16-inch Liquid Retina XDR display",
- "assetType": "PHYSICAL",
- "assetProvider": "AGENT",
- "removedAt": null,
- "notes": null,
- "assetReferenceType": "WORKSTATION",
- "externalId": null,
- "externalOwnerId": null,
- "uniqueId": "zgf5nl7bie2qnw0z2xxx",
- "createdAt": "2025-01-08T21:31:55.610Z",
- "updatedAt": "2025-01-08T21:31:55.610Z"
}, - "userId": 1,
- "personnelId": 1,
- "externalId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd"
}
🔒 Requires Devices: List Devices permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "id": 1,
- "osVersion": "MacOS 10.15.6",
- "serialNumber": "C02T6CDJGTFL",
- "model": "MacBook Pro",
- "macAddress": "65-F9-3D-85-7B-6B,99-A9-3E-14-7A-3E",
- "encryptionEnabled": false,
- "encryptionExplanation": "No encryption provided",
- "firewallEnabled": true,
- "firewallExplanation": "{}",
- "lastCheckedAt": "2025-07-01T16:45:55.246Z",
- "sourceType": "AGENT",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z",
- "deletedAt": "2025-07-01T16:45:55.246Z",
- "appsCount": 20,
- "complianceChecks": [ ],
- "identifiers": [ ],
- "documents": [ ],
- "isDeviceCompliant": false,
- "screenLockTime": 30,
- "screenLockExplanation": {
- "minutesIdleBeforeSleep": "2",
- "minutesSleepingBeforePasswordIsRequired": "2"
}, - "antivirusEnabled": true,
- "antivirusExplanation": "No matching app was found",
- "autoUpdateEnabled": true,
- "autoUpdateExplanation": "No compliances found",
- "passwordManagerEnabled": true,
- "passwordManagerExplanation": {
- "passwordManagerApps": [
- "1password 7"
]
}, - "asset": {
- "id": 651,
- "name": "MacBook Pro - Space Black 16-inch",
- "description": "MacBook Pro Space Black - with 16-inch Liquid Retina XDR display",
- "assetType": "PHYSICAL",
- "assetProvider": "AGENT",
- "removedAt": null,
- "notes": null,
- "assetReferenceType": "WORKSTATION",
- "externalId": null,
- "externalOwnerId": null,
- "uniqueId": "zgf5nl7bie2qnw0z2xxx",
- "createdAt": "2025-01-08T21:31:55.610Z",
- "updatedAt": "2025-01-08T21:31:55.610Z"
}, - "userId": 1,
- "personnelId": 1,
- "externalId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
- "apps": [ ]
}
🧪 BETA: Get a list of devices for a given connection
🔒 Requires Devices: List Devices permission.
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
Internal server error
{- "data": [
- {
- "externalId": "3000",
- "personnelId": 206,
- "userId": 207,
- "id": 3,
- "osVersion": "MacOS 11",
- "serialNumber": "q77gfdp0xg03vcu6t1fi",
- "model": "MacBook Pro 14-in(2021)",
- "macAddress": "91:2b:4a:7a:51:73",
- "encryptionEnabled": null,
- "firewallEnabled": null,
- "gateKeeperEnabled": null,
- "lastCheckedAt": "2024-11-25T22:16:23.479Z",
- "sourceType": "AGENT",
- "createdAt": "2024-11-25T22:16:23.479Z",
- "updatedAt": "2024-12-08T22:20:15.041Z",
- "deletedAt": null,
- "appsCount": null
}, - {
- "externalId": "4000",
- "personnelId": 305,
- "userId": 306,
- "id": 4,
- "osVersion": "MacOS 12",
- "serialNumber": "locldk8eyxn28eyb3ktj",
- "model": "MacBook Pro 16-in(2021)",
- "macAddress": "0f:8a:67:b2:90:ad",
- "encryptionEnabled": null,
- "firewallEnabled": null,
- "gateKeeperEnabled": null,
- "lastCheckedAt": "2024-11-25T22:16:23.705Z",
- "sourceType": "AGENT",
- "createdAt": "2024-11-25T22:16:23.705Z",
- "updatedAt": "2024-12-08T22:20:15.041Z",
- "deletedAt": null,
- "appsCount": null
}
], - "page": 1,
- "limit": 10,
- "total": 100
}
🧪 BETA: Create a new device or update an existing device for a custom connection.
An existing device is searched for based upon matching one or more of these supplied properties in the request payload:
serialNumber
macAddress
externalId
If an existing device is found, the existing device is updated. Otherwise a new device is created.
🔒 Requires Devices: Create Device permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
Not Found
You must accept the Drata terms and conditions to use the API
The file was too large to upload
Internal server error
Third party system was unavailable
{- "personnelId": 1,
- "alias": "danielm-01",
- "antivirusEnabled": true,
- "antivirusExplanation": {
- "antivirusApps": [
- "Crowdstrike windows sensor"
]
}, - "appList": [
- {
- "name": "Microsoft Defender Antivirus",
- "version": "1.421.12.0",
- "description": "Microsoft Defender Antivirus"
}
], - "autoUpdateEnabled": true,
- "autoUpdateExplanation": "Disabled",
- "browserExtensions": [
- {
- "name": "Microsoft Defender Antivirus",
- "version": "1.421.12.0",
- "description": "Microsoft Defender Antivirus"
}
], - "externalId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
- "firewallEnabled": true,
- "firewallExplanation": "On",
- "passwordManagerEnabled": true,
- "encryptionEnabled": true,
- "encryptionExplanation": {
- "bootPartitionEncryptionDetails": {
- "partitionFileVault2Percent": 100,
- "partitionFileVault2State": "ENCRYPTED",
- "partitionName": "Macintosh HD (Boot Partition)"
}
}, - "model": "Mac16,1",
- "serialNumber": "BKH8RXT4T9",
- "macAddress": "01-23-45-67-89-AB",
- "passwordManagerExplanation": {
- "passwordManagerApps": [
- "1password"
]
}, - "platformName": "MACOS",
- "platformVersion": "string",
- "screenLockEnabled": true,
- "screenLockExplanation": "ScreenLock delay is immediate",
- "screenLockTime": 15,
- "windowsServices": [
- {
- "description": "Security feature that monitors and controls network traffic entering and exiting the device",
- "name": "Windows Firewall",
- "startType": "Automatic",
- "status": "Running"
}
]
}
{- "id": 1,
- "osVersion": "MacOS 10.15.6",
- "serialNumber": "C02T6CDJGTFL",
- "model": "MacBook Pro",
- "macAddress": "65-F9-3D-85-7B-6B,99-A9-3E-14-7A-3E",
- "encryptionEnabled": false,
- "encryptionExplanation": "No encryption provided",
- "firewallEnabled": true,
- "firewallExplanation": "{}",
- "lastCheckedAt": "2025-07-01T16:45:55.246Z",
- "sourceType": "AGENT",
- "createdAt": "2025-07-01T16:45:55.246Z",
- "updatedAt": "2025-07-01T16:45:55.246Z",
- "deletedAt": "2025-07-01T16:45:55.246Z",
- "appsCount": 20,
- "complianceChecks": [ ],
- "identifiers": [ ],
- "documents": [ ],
- "isDeviceCompliant": false,
- "screenLockTime": 30,
- "screenLockExplanation": {
- "minutesIdleBeforeSleep": "2",
- "minutesSleepingBeforePasswordIsRequired": "2"
}, - "antivirusEnabled": true,
- "antivirusExplanation": "No matching app was found",
- "autoUpdateEnabled": true,
- "autoUpdateExplanation": "No compliances found",
- "passwordManagerEnabled": true,
- "passwordManagerExplanation": {
- "passwordManagerApps": [
- "1password 7"
]
}, - "asset": {
- "id": 651,
- "name": "MacBook Pro - Space Black 16-inch",
- "description": "MacBook Pro Space Black - with 16-inch Liquid Retina XDR display",
- "assetType": "PHYSICAL",
- "assetProvider": "AGENT",
- "removedAt": null,
- "notes": null,
- "assetReferenceType": "WORKSTATION",
- "externalId": null,
- "externalOwnerId": null,
- "uniqueId": "zgf5nl7bie2qnw0z2xxx",
- "createdAt": "2025-01-08T21:31:55.610Z",
- "updatedAt": "2025-01-08T21:31:55.610Z"
}, - "userId": 1,
- "personnelId": 1,
- "externalId": "aaaaaaaa-bbbb-0000-cccc-dddddddddddd"
}
Get a list of apps associated with a given device
🔒 Requires Devices: List Devices permission.
Malformed data and/or validation errors
Invalid Authorization
You must upgrade your plan to use this feature
You are not allowed to perform this action
You must accept the Drata terms and conditions to use the API
Internal server error
{- "data": [
- {
- "id": 242,
- "installedApp": "Photoshop version 26.0 license 1a2b3c"
}, - {
- "id": 243,
- "installedApp": "Microsoft Word version 2411 (Build 18227.20162) license 9w9e8b"
}
], - "page": 1,
- "limit": 10,
- "total": 100
}