# Create a recurring inventory scan schedule

Creates a recurring inventory scan schedule for managed devices.

**Schedule Types:**

- Daily: Run scans every day, on alternate days, or on weekdays only
- Weekly: Run scans on specific days of the week
- Monthly: Run scans on specific months and days

**Note:** Required fields vary based on the selected scheduleType. Refer to the request examples for each schedule type.

## Endpoint

`POST /bsp/api/v1/bmp/devices/scan/schedule`

## Request

### Request URL

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

### Scope

```text
BrowserManager.CREATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

- **Accept** (`string`, Mandatory): `application/json`
- **Content-Type** (`string`, Mandatory): `application/json`

#### Request Body

`application/json`

- `JSON Object`
  - **Schedule Config** (Optional)

## Examples

### Daily Schedule

Run scan every day, on alternate days, or on weekdays.

#### Sample Request

```curl
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/devices/scan/schedule \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"dailyTime":"04/14/2026, 08:47","taskTimeZone":"Asia/Calcutta","scheduleType":"Daily","schedulerDisabled":false,"dailyIntervalType":"alternativeDays"}'
```

#### Sample Request Body

```json
{
  "dailyTime": "04/14/2026, 08:47",
  "taskTimeZone": "Asia/Calcutta",
  "scheduleType": "Daily",
  "schedulerDisabled": false,
  "dailyIntervalType": "alternativeDays"
}
```

## Response Parameters

### HTTP Code 204

Response body: `application/json`

- `JSON Object`

### HTTP Code 400

Response body: `application/json`

Bad request error when an invalid or unsupported parameter is detected in the scan schedule request.

- `JSON Object`
  - **errorCode** (`string`): Error code indicating an invalid parameter was detected in the request
  - **errorMsg** (`string`): Message identifying the invalid parameter that was detected
  - **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 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`

Internal server error during device operations.

- `JSON Object`
  - **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
- **429** HTTP code
- **500** HTTP code

## Sample Responses

### HTTP 204

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

### HTTP 400

Invalid parameter

```json
{
  "errorCode": "IAM0018",
  "url": "/bsp/api/v1/bmp/devices/scan/schedule",
  "errorMsg": "Invalid parameter \"param\" detected."
}
```

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

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