# Retrieves a paginated list of all BitLocker policies

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

## Endpoint

`GET /bitlocker/api/policy/allpolicies`

## Request

### Request URL

https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/bitlocker/api/policy/allpolicies

### Scope

`DesktopCentralCloud.DataEncryption.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` — **Mandatory**
  - `application/json`

#### Query Parameters

- **searchStr** `string` — Optional
  - Search filter string for policy name
- **startIndex** `integer` — Optional
  - Pagination start index. Defaults to 0 if not provided
- **limit** `integer` — Optional
  - Number of results per page. Defaults to 5 if not provided

### Sample Request

```bash
curl --request GET \
  --url https://appdomains/bitlocker/api/policy/allpolicies \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

Response body: `application/json`

`JSON Object`

- **allpolicy** `JSON Array`
  - List of BitLocker policies

#### Sample Response: HTTP 200

Successful retrieval of all BitLocker policies

```json
{
  "allpolicy": [
    {
      "policyID": "1218",
      "policyName": "Policy_3233",
      "status": true
    }
  ]
}
```

### HTTP Code 400

Response body: `application/json`

`JSON Object`

- **errorCode** `long`
  - 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)
- **errorMsg** `string`
  - Detailed message identifying which query parameter failed validation

#### Sample Response: HTTP 400

Invalid query parameters

```json
{
  "errorCode": 40001,
  "errorMsg": "Invalid request parameters"
}
```

### HTTP Code 401

Response body: `application/json`

`JSON Object`

- **errorCode** `long`
  - Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
- **errorMsg** `string`
  - Authentication failure reason

#### Sample Response: HTTP 401

Authentication credentials missing or invalid

```json
{
  "errorCode": 40101,
  "errorMsg": "Authentication failed"
}
```

### HTTP Code 403

Response body: `application/json`

`JSON Object`

- **errorCode** `long`
  - Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
- **errorMsg** `string`
  - Message indicating insufficient privileges to access this resource

#### Sample Response: HTTP 403

User does not have DataEncryption_Admin role

```json
{
  "errorCode": 40301,
  "errorMsg": "Insufficient privileges to access this resource"
}
```

### HTTP Code 429

Response body: `application/json`

`JSON Object`

- **errorCode** `long`
  - 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
- **errorMsg** `string`
  - Rate limit exceeded message with retry guidance

#### Sample Response: HTTP 429

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

```json
{
  "errorCode": 42901,
  "errorMsg": "Too many requests. Please retry after the cooldown period"
}
```

### HTTP Code 500

Response body: `application/json`

`JSON Object`

- **errorCode** `long`
  - Internal server error code (DCAPIErrorCodes.INTERNAL_ERROR) thrown from the controller catch block while fetching or forming the policy list response
- **errorMsg** `string`
  - Server-side error message — typically 'Exception while forming response'

#### Sample Response: HTTP 500

Internal server error — thrown from catch block via DCAPIException

```json
{
  "errorCode": 10000,
  "errorMsg": "Exception while forming response"
}
```

## Rate Limits

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.