# Retrieve scan status of managed computers

Returns the list of computers along with their scan status, agent install status, and agent live status.

## Endpoint

`GET /dcapi/inventory/viewData/scanComputers`

### Request URL

https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/dcapi/inventory/viewData/scanComputers

### Scope

`DesktopCentralCloud.Inventory.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** (`string`, Mandatory): `application/InventoryMobileAPI.v1+json`

#### Query Parameters

- **toolID** (`string`, Mandatory): Set value as 2131.
- **domain** (`string`, Optional): Domain name to filter computers. Obtain from the response of the [Get Computers List](https://www.manageengine.com/products/desktop-central/help/api/cloud/computers-getcomputers.html) API.
- **customGroup** (`string`, Optional): Custom group ID to filter computers. Obtain it from the response of the [Get Custom Group List](https://www.manageengine.com/products/desktop-central/help/api/cloud/custom-groups-get-cglist.html) API.
- **scanFilter** (`string`, Optional): Scan filter status. Allowed values: 21 - Yet to install, 22 - Installed, 23 - Uninstalled, 24 - Yet to uninstall, 29 - Installation failure.
- **scanStatus** (`string`, Optional): Scan status. Allowed values: -1 - Not done, 0 - Failed, 1 - In progress, 2 - Success.
- **agentStatus** (`string`, Optional): Agent live status. Allowed values: 1 - Live, 2 - Down, 3 - Unknown.
- **resID** (`string`, Optional): Resource ID of the computer. Obtain from the response of the [Get Computers List](https://www.manageengine.com/products/desktop-central/help/api/cloud/computers-getcomputers.html) API.

### Sample Request

```curl
curl --request GET \
  --url 'https://appdomains/dcapi/inventory/viewData/scanComputers?toolID=2131' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

Response Body: `application/json`

- **Response body** (`JSON Object`)
  - **metadata** (`JSON Object`): Pagination metadata.
  - **totalRecords** (`string`): Total number of records matching the query.
  - **messageResponse** (`JSON Array`): Array of computer scan detail objects.
  - **totalPages** (`string`): Total number of pages.
  - **Links** (`JSON Object`): Pagination links.
  - **status** (`string`): Response status - success.

### HTTP Code 500

Response Body: `application/json`

- **Response body** (`JSON Object`)
  - **error_code** (`string`): INTERNAL_ERROR - unexpected exception in the service layer.
  - **error_description** (`string`): Internal server error message.

### Possible Response Codes

- **200**: HTTP code.
- **500**: HTTP code.

### Sample Response: HTTP 200

Scan computers view

```json
{
  "metadata": {
    "limit": 25,
    "page": 1
  },
  "totalRecords": "1",
  "messageResponse": [
    {
      "agent_version_transform": "11.5.2613.01.W",
      "resource_name_transform": "sample-computer",
      "agent_installed_on": "1778751125720",
      "process_start_time": "-1",
      "service_pack": "Windows 11 Version 25H2 (x64)",
      "os_name_transform": "Windows 11 Professional Edition (x64)",
      "software_name": "Windows 11 Professional Edition (x64)",
      "domain_netbios_name_transform": "WORKGROUP",
      "scan_remarks": "dc.common.SCANNING_COMPLETED",
      "branch_office_name_transform": "Local Office",
      "agent_last_contact_time_transform": "May 14, 2026 04:30 PM",
      "os_platform": "1",
      "fqdn_name_transform": "SAMPLE-COMPUTER.DOMAIN.COM",
      "status_label": "dc.db.som.status.installed_successfully",
      "audit_type_transform": "On-demand Scan",
      "name": "SampleUser",
      "installation_status": "22",
      "scan_status_transform": "2",
      "os_version_transform": "10.0.26200",
      "friendly_name_transform": "sample-computer",
      "last_successful_scan": "1778751156691",
      "scan_remarks_transform": "Scanning Completed",
      "branch_office_name": "Local Office",
      "agent_last_contact_time": "1778756427000",
      "domain_netbios_name": "WORKGROUP",
      "process_end_time_transform": "May 14, 2026 03:02 PM",
      "status_label_transform": "Installed Successfully",
      "fqdn_name": "SAMPLE-COMPUTER.DOMAIN.COM",
      "ip_address_transform": "10.0.0.1",
      "agent_installed_on_transform": "May 14, 2026 03:02 PM",
      "mac_address": "00:00:00:00:00:00",
      "scan_remarks_en": "Scanning Completed",
      "friendly_name": "sample-computer",
      "scan_status": "2",
      "last_successful_scan_transform": "May 14, 2026 03:02 PM",
      "os_version": "10.0.26200",
      "process_end_time": "1778751156691",
      "ip_address": "10.0.0.1",
      "service_pack_transform": "Windows 11 Version 25H2 (x64)",
      "agent_version": "11.5.2613.01.W",
      "mac_address_transform": "00:00:00:00:00:00",
      "name_transform": "SampleUser",
      "servicetag": "SAMPLE01",
      "resource_id": "301",
      "build_number": "26200.8246",
      "os_name": "Windows 11 Professional Edition (x64)",
      "computer_live_status": "1",
      "resource_name": "sample-computer",
      "customer_id": "1",
      "build_number_transform": "26200.8246",
      "servicetag_transform": "SAMPLE01",
      "scan_remarks_en_transform": "Scanning Completed",
      "audit_type": "1"
    }
  ],
  "totalPages": 1,
  "Links": {
    "next": null,
    "prev": null
  },
  "status": "success"
}
```

### Sample Response: HTTP 500

Server error

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

## API Request Limits

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

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