# Get a device's compliance details

Retrieves the per-rule compliance status of every browser on a device against the default BSP compliance rules.

## Endpoint

`GET /bsp/api/v1/bmp/devices/{device_id}/compliance`

## Request

### Request URL

`https://{server-hostname}:8383/bsp/api/v1/bmp/devices/{device_id}/compliance`

### Scope

`BrowserManager.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** (`string`, mandatory): `application/json`

#### Path Parameters

- **device_id** (`string`, mandatory): Device resource ID from [List Devices](https://www.manageengine.com/products/desktop-central/help/api/onpremise/inventory-list-devices.html) response (`device_id` field).

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/devices/{device_id}/compliance \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP 200

**Response Body:** `application/json`

- `JSON Object`: Compliance details for a device, wrapped in a devices array.
  - **devices** (`JSON Array`): Device compliance objects.

### HTTP 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.

### HTTP 403

**Response Body:** `application/json`

- `JSON Object`: RBCA scope violation when device is not in the user's managed scope.
  - **errorCode** (`string`): Error code indicating the device is outside the user's managed scope.
  - **errorMsg** (`string`): Message indicating the device is not accessible to the current user.
  - **url** (`string`): Request URL that triggered the error.

### HTTP 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.

### HTTP 500

**Response Body:** `application/json`

- `JSON Object`: Internal server error during device operations.
  - **error_description** (`string`): Message describing the server-side failure.
  - **error_code** (`string`): Internal server error code.

### Possible Response Codes

- `200` HTTP code
- `401` HTTP code
- `403` HTTP code
- `429` HTTP code
- `500` HTTP code

### Sample Response: HTTP 200

#### Default compliance (without compliance_id)

```json
{
  "devices": [
    {
      "compliance_details": [
        {
          "category_details": [
            {
              "rule_id": "1",
              "non_compliant_rules": [
                6,
                8,
                9,
                42,
                43,
                12,
                44,
                45,
                14,
                46,
                47,
                48,
                17,
                50,
                51,
                52
              ],
              "rule_name": "Data Leakage Prevention",
              "security_percentage": "7.194244861602783",
              "yet_to_scan": [],
              "compliant_rules": [
                18
              ]
            },
            {
              "rule_id": "2",
              "non_compliant_rules": [
                16,
                4,
                68,
                5,
                7,
                11,
                13,
                15
              ],
              "rule_name": "Threat Prevention",
              "security_percentage": "26.3157901763916",
              "yet_to_scan": [],
              "compliant_rules": [
                10
              ]
            }
          ],
          "security_percentage": "12.755102157592773",
          "compliance_id": "1",
          "rule_status": [
            {
              "rule_id": "13",
              "rule_name": "addon_blocked_restriction",
              "compliant_status": "0",
              "criticality": "2"
            },
            {
              "rule_id": "10",
              "rule_name": "critical_permissions",
              "compliant_status": "1",
              "criticality": "3"
            },
            {
              "rule_id": "5",
              "rule_name": "phishing_filter",
              "compliant_status": "0",
              "criticality": "3"
            },
            {
              "rule_id": "18",
              "rule_name": "sideload_extensions",
              "compliant_status": "1",
              "criticality": "2"
            }
          ]
        }
      ],
      "device_id": "888"
    }
  ]
}
```

#### Empty compliance

```json
{
  "devices": []
}
```

### Sample Response: HTTP 401

#### Unauthorized

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

### Sample Response: HTTP 403

#### Device not in scope

```json
{
  "errorCode": "FORBIDDEN",
  "url": "/bsp/api/v1/bmp/devices/{device_id}/compliance",
  "errorMsg": "The requested device is not in your managed scope"
}
```

### Sample Response: HTTP 429

#### Rate limit exceeded

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
```

### Sample Response: HTTP 500

#### Server error

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

## Rate Limiting

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

**Duration:** 1 minute | **Threshold:** 60 | **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.