# Trigger warranty scan for managed computers

Initiates a bulk warranty scan for managed computers. Fetches the latest warranty information from configured vendors.

## Endpoint

`POST /dcapi/inventory/initiateWarrantyScan`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/inventory/initiateWarrantyScan`

### Scope

`Inventory.CREATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Content-Type** `string` — **Mandatory**  
  `application/initiateWarrantyScanDetails.v1+json`

- **Accept** `string` — **Mandatory**  
  `application/initiateWarrantyScanStatus.v1+json`

#### Request Body

`application/json`

- `scanType` `string` — **Mandatory**  
  Scan target. 0 - All devices, 1 - Expired devices only, 2 - Soon-to-expire devices only.

- `vendorID` `long` — Optional  
  Restricts scan to a specific vendor. Omit to scan across all configured vendors. 1 - Dell, 2 - Lenovo, 3 - Toshiba, 4 - HP

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/inventory/initiateWarrantyScan \
  --header 'Accept: application/initiateWarrantyScanStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/initiateWarrantyScanDetails.v1+json' \
  --data '{"scanType":0}'
```

### Sample Request Body

#### Scan all devices for any vendor

```json
{
  "scanType": 0
}
```

#### Scan only expired devices for a specific vendor

```json
{
  "vendorID": 1,
  "scanType": 1
}
```

## Response Parameters

### HTTP Code 200

Response body: `application/json`

- `status` `string`  
  Result - Success or Failure

- `statusMessage` `string`  
  Human-readable result message

#### Sample Response: HTTP 200

Bulk scan initiated

```json
{
  "statusMessage": "Warranty scan has been initiated successfully.",
  "status": "success"
}
```

### HTTP Code 401

Response body: `application/json`

- `error_code` `string`  
  UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

- `error_description` `string`  
  Authentication or authorization failure reason

#### Sample Response: HTTP 401

Missing credentials

```json
{
  "error_description": "Unauthorized access",
  "error_code": "UAC_UNAUTHORIZED"
}
```

### HTTP Code 500

Response body: `application/json`

- `error_code` `string`  
  INTERNAL_ERROR - unexpected exception in the service layer

- `error_description` `string`  
  Internal server error message

#### Sample Response: HTTP 500

Server error

```json
{
  "error_description": "Internal server error",
  "error_code": "INTERNAL_ERROR"
}
```

### Possible Response Codes

- `200` — HTTP code
- `401` — HTTP code
- `500` — HTTP code

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