# Retrieve aggregated inventory summary

Returns an aggregated summary of all inventory data including software, hardware, and computer counts across the managed environment.

## Endpoint

`GET /dcapi/inventory/allsummary`

## Request

### Request URL

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

### Scope

`Inventory.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

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

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/inventory/allsummary \
  --header 'Accept: application/allsummary.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

Response Body: `application/json`

`JSON Object`

- **audit_summary** (`JSON Object`): Scan audit summary with counts of successful, failed, and not-scanned computers
- **software_compliance_summary** (`JSON Object`): Software license compliance summary with counts by status
- **warranty_summary** (`JSON Object`): Warranty status summary with counts of compliant, expired, and unidentified
- **computer_by_os** (`JSON Object`): Computer count grouped by operating system name
- **software_summary** (`JSON Object`): Software summary with total, prohibited, commercial, and non-commercial counts

#### Sample Response: HTTP 200

Aggregated summary

```json
{
  "audit_summary": {
    "not_scanned": "0",
    "scan_failed": "0",
    "scan_success": "1"
  },
  "software_summary": {
    "commercial_software": "0",
    "total_software": "36",
    "prohibited_software": "0",
    "non_commercial_software": "0"
  },
  "software_compliance_summary": {
    "expired_license": "0",
    "over_licensed": "0",
    "under_licensed": "0",
    "license_in_compliance": "0"
  },
  "computer_by_os": {
    "Windows 11": "1"
  },
  "warranty_summary": {
    "unidentified": "0",
    "expired_warranty": "1",
    "warranty_in_compliance": "0"
  }
}
```

### HTTP Code 400

Response Body: `application/json`

`JSON Object`

- **error_code** (`string`): `CUSTOMER_HEADER_MISSING` - MSP environment requires X-Customer header
- **error_description** (`string`): Missing customer header error message

#### Sample Response: HTTP 400

MSP header missing

```json
{
  "error_description": "dc.rest.customer_header.missing",
  "error_code": "CUSTOMER_HEADER_MISSING"
}
```

### HTTP Code 401

Response Body: `application/json`

`JSON Object`

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

`JSON Object`

- **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
- **400**: HTTP code
- **401**: HTTP code
- **500**: HTTP code

## Rate Limit

![](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.