# Retrieve storage add-on usage for a specific module

Returns purchased, used, and available storage in GB and bytes for the specified module. Set `splitRequired=true` for a sub-module breakdown. Supported: `moduleId` `1` = OS Deployer.

## Endpoint

`GET /dcapi/license/storageDetails`

## Request URL

`https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/dcapi/license/storageDetails`

## Scope

`DesktopCentralCloud.Admin.READ`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

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

## Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/license/storageDetails \
  --header 'Accept: application/storageAddonDetails.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP code 200

Response body: `application/json`

`JSON Object`

- **totalPurchasedStorage** (`long`): Total storage allocated in GB.
- **totalManagedStorage** (`string`): Storage currently consumed in GB (formatted with decimal precision).
- **totalAvailableStorage** (`string`): Remaining storage available in GB (formatted with decimal precision).
- **totalPurchasedStorageInBytes** (`long`): Total storage allocated in bytes.
- **totalManagedStorageInBytes** (`long`): Storage currently consumed in bytes.
- **totalAvailableStorageInBytes** (`long`): Remaining storage available in bytes.
- **storageDetails** (`JSON Array`): Per-module storage breakdown. Present when `splitRequired=true`.

### HTTP code 400

Response body: `application/json`

`JSON Object`

- **status** (`string`): Error message indicating the provided `moduleId` is invalid or does not exist. See [Get Storage Add-on Details](https://www.manageengine.com/products/desktop-central/help/api/cloud/get-storage-details.html) for supported `moduleId` values.

### HTTP code 401

Response body: `application/json`

`JSON Object`

- **status** (`string`): Error message indicating the caller does not have the required role to access the requested module.

### HTTP code 500

Response body: `application/json`

`JSON Object`

- **error_code** (`integer`): Error code. `1001` indicates an unexpected failure while fetching storage add-on details.
- **error_description** (`string`): Human-readable error message describing the failure.

## Sample Responses

### HTTP 200

Storage usage without sub-module breakdown:

```json
{
  "totalPurchasedStorage": 10,
  "totalManagedStorage": "4.76",
  "totalPurchasedStorageInBytes": 10737418240,
  "totalManagedStorageInBytes": 5111808000,
  "totalAvailableStorageInBytes": 5625610240,
  "totalAvailableStorage": "5.24"
}
```

Storage usage with sub-module breakdown (`splitRequired=true`, `moduleId=1`):

```json
{
  "storageDetails": [
    {
      "usedStorageSplit": [
        {
          "usedSpace": "2.0",
          "transientSpace": "0.5",
          "subModule": "bootImages"
        },
        {
          "usedSpace": "1.2",
          "transientSpace": "0",
          "subModule": "driverPacks"
        }
      ],
      "managed": 3435973837,
      "module": "osdImages"
    }
  ],
  "totalPurchasedStorage": 10,
  "totalManagedStorage": "4.76",
  "totalPurchasedStorageInBytes": 10737418240,
  "totalManagedStorageInBytes": 5111808000,
  "totalAvailableStorageInBytes": 5625610240,
  "totalAvailableStorage": "5.24"
}
```

### HTTP 400

The provided `moduleId` is not valid or does not exist.

```json
{
  "status": "Incorrect module Id"
}
```

### HTTP 401

Caller does not have access to the requested module.

```json
{
  "status": "User does not have access to the requested module"
}
```

### HTTP 500

Unexpected server error while fetching storage add-on details.

```json
{
  "error_description": "An internal error occurred while processing the request.",
  "error_code": 1001
}
```

## Rate Limits

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