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

Copy full URL

Request URL

https://{serverurl}/dcapi/license/storageDetails Copied!

Scope

DesktopCentralCloud.Admin.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/storageAddonDetails.v1+jsonCopied!

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

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

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/license/storageDetails"))
        .header("Accept", "application/storageAddonDetails.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = {
    'Accept': "application/storageAddonDetails.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/license/storageDetails", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/storageAddonDetails.v1+json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/license/storageDetails"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/storageAddonDetails.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/license/storageDetails' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

totalPurchasedStoragelong

Total storage allocated in GB.

totalManagedStoragestring

Storage currently consumed in GB (formatted with decimal precision).

totalAvailableStoragestring

Remaining storage available in GB (formatted with decimal precision).

totalPurchasedStorageInByteslong

Total storage allocated in bytes.

totalManagedStorageInByteslong

Storage currently consumed in bytes.

totalAvailableStorageInByteslong

Remaining storage available in bytes.

storageDetailsJSON Array

Per-module storage breakdown. Present when splitRequired=true.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

modulestring

Module name (e.g. osdImages, reports).

managedlong

Total storage consumed by this module in bytes.

usedStorageSplitJSON Array

Sub-module breakdown within this module. Present when splitRequired=true.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

modulestring

Module name (e.g. osdImages, reports).

managedlong

Total storage consumed by this module in bytes.

usedStorageSplitJSON Array

Sub-module breakdown within this module. Present when splitRequired=true.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

JSON Object

Show Sub-Attributes

modulestring

Module name (e.g. osdImages, reports).

managedlong

Total storage consumed by this module in bytes.

usedStorageSplitJSON Array

Sub-module breakdown within this module. Present when splitRequired=true.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

modulestring

Module name (e.g. osdImages, reports).

managedlong

Total storage consumed by this module in bytes.

usedStorageSplitJSON Array

Sub-module breakdown within this module. Present when splitRequired=true.

Show Sub-Attributes

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

JSON Object

Show Sub-Attributes

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

subModulestring

Sub-module name (e.g. bootImages, driverPacks).

usedSpacestring

Storage consumed by this sub-module in GB (formatted with decimal precision).

transientSpacestring

Transient/temporary storage consumed by this sub-module in GB.

- HTTP code 400

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Error message indicating the provided moduleId is invalid or does not exist. See Get Storage Add-on Details for supported moduleId values.

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

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

Hide Sub-Attributes

error_codeinteger

Error code. 1001 indicates an unexpected failure while fetching storage add-on details.

error_descriptionstring

Human-readable error message describing the failure.

Sample Response: HTTP 200

Storage usage without sub-module breakdown

Copied!

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

▼ Show full

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

Copied!

  {
    "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"
  }

▼ Show full

Sample Response: HTTP 400

The provided moduleId is not valid or does not exist

Copied!

  {
    "status": "Incorrect module Id"
  }

▼ Show full

Sample Response: HTTP 401

Caller does not have access to the requested module

Copied!

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

▼ Show full

Sample Response: HTTP 500

Unexpected server error while fetching storage add-on details

Copied!

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

▼ Show full

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.