Retrieves a paginated list of all BitLocker policies

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns all BitLocker policies for the current customer with optional search and pagination support.

Request URL

https://{server-hostname}:8383/bitlocker/api/policy/allpolicies

Scope

DataEncryption.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/bitlocker/api/policy/allpolicies \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
allpolicyJSON Array

List of BitLocker policies

Show Sub-Attributes
JSON Object
Show Sub-Attributes
policyIDstring

Unique identifier of the BitLocker policy

policyNamestring

Name of the BitLocker policy

statusboolean

Whether the policy is published (true) or not (false)

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Validation error code raised when query parameters fail security XML regex checks (searchStr exceeds uem_safestring max-len=255, startIndex/limit not integers or exceed max-len=10)

errorMsgstring

Detailed message identifying which query parameter failed validation

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Internal server error code (DCAPIErrorCodes.INTERNAL_ERROR) thrown from the controller catch block while fetching or forming the policy list response

errorMsgstring

Server-side error message — typically 'Exception while forming response'

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Successful retrieval of all BitLocker policies

Copied!
  {
    "allpolicy": [
      {
        "policyID": "1218",
        "policyName": "Policy_3233",
        "status": true
      }
    ]
  }
                
Show full

Sample Response: HTTP 400

Invalid query parameters

Copied!
  {
    "errorCode": 40001,
    "errorMsg": "Invalid request parameters"
  }
                
Show full

Sample Response: HTTP 401

Authentication credentials missing or invalid

Copied!
  {
    "errorCode": 40101,
    "errorMsg": "Authentication failed"
  }
                
Show full

Sample Response: HTTP 403

User does not have DataEncryption_Admin role

Copied!
  {
    "errorCode": 40301,
    "errorMsg": "Insufficient privileges to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Throttle limit exceeded; client locked out for lock-period minutes

Copied!
  {
    "errorCode": 42901,
    "errorMsg": "Too many requests. Please retry after the cooldown period"
  }
                
Show full

Sample Response: HTTP 500

Internal server error — thrown from catch block via DCAPIException

Copied!
  {
    "errorCode": 10000,
    "errorMsg": "Exception while forming response"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.