# Trigger an inventory scan on devices

Triggers an on-demand inventory scan on the specified devices.

**Endpoint:** `POST /bsp/api/v1/bmp/devices/scan`

## Request URL

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

## Scope

`BrowserManager.CREATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

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

### Request Body

`application/json`

`JSON Object`

Request body for triggering an immediate inventory scan on specified devices.

- **device_ids** `array` — Optional  
  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 POST \
  --url https://appdomain/bsp/api/v1/bmp/devices/scan \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"device_ids":[999,888]}'
```

## Sample Request Body

### Scan two devices

```json
{
  "device_ids": [
    999,
    888
  ]
}
```

### Scan single device

```json
{
  "device_ids": [
    777
  ]
}
```

## Response Parameters

### HTTP code 204

Response Body — `application/json`

`JSON Object`

### HTTP code 400

Response Body — `application/json`

`JSON Object`

Bad request error when `device_ids` array size exceeds 1-100 range.

- **errorCode** `string`  
  Error code indicating the `device_ids` array size is outside the allowed 1-100 range
- **errorMsg** `string`  
  Message indicating the array size constraint violation
- **url** `string`  
  Request URL that triggered the error

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

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

### HTTP code 404

Response Body — `application/json`

`JSON Object`

Not found error when one or more device IDs do not exist.

- **errormsg** `string`  
  Message indicating the device ID was not found

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

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

- **204** `HTTP code`  
  Returns 204 No Content on success.
- **400** `HTTP code`
- **401** `HTTP code`
- **403** `HTTP code`
- **404** `HTTP code`
- **429** `HTTP code`
- **500** `HTTP code`

## Sample Responses

### HTTP 204

```text
204 Returns 204 No Content on success.
```

### HTTP 400

Array size exceeded

```json
{
  "errorCode": "COM0014",
  "url": "/bsp/api/v1/bmp/devices/scan",
  "errorMsg": "ARRAY_SIZE_OUT_OF_RANGE"
}
```

### HTTP 401

Unauthorized

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

### HTTP 403

Forbidden

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

### HTTP 404

Device not found

```json
{
  "errormsg": "Device ID not found"
}
```

### HTTP 429

Rate limit exceeded

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

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