Use Cases

• Inventory All Disks in a Subscription Call this endpoint to get a complete view of every disk — root disks, data disks, and unattached volumes — within a subscription. Use the type and status fields in the response to categorize and audit your storage resources.
• Find Unattached Disks Available for Reuse Filter the response by checking for disks where serverId is null. These are disks not currently attached to any server and can be attached to a new or existing server using the Attach Disk to Server endpoint, avoiding unnecessary disk creation.
• Monitor Disk Status and Capacity Periodically poll this endpoint to track disk states (e.g., Ready, provisioning) and sizes across your infrastructure. Build alerts or dashboards that flag disks nearing capacity limits or stuck in unexpected states.
• Retrieve Disk IDs for Downstream Operations Before calling endpoints like Attach Disk to Server or Delete a Disk, use this endpoint to look up the target diskId. Filter by name or publicName to locate the specific disk programmatically instead of hardcoding IDs.
• Reconcile Disk-to-Server Mappings Use the serverId field in each disk response to build a map of which disks belong to which servers. This is useful for infrastructure audits, billing reconciliation, and verifying that multi-disk server configurations match your expected architecture.

Getting Required Parameters

• subscriptionId (query): Retrieve available subscription IDs using the List all Subscriptions endpoint. Pass your organizationId as a query parameter to get all subscriptions for your organization, then use the id field from the response.