vRealize Automation Reclamation Service API

Reclamation Service API Specification

What Is the Reclamation Service?

You can use the reclamation service to query the VMs in an installation for non-usage and, if they are not in use, mark them as eligible for reclamation.

Usage statistics data for the VMs is retrieved from IaaS. If vRealize Operations Manager (vROps) is attached to the vRA instance, then usage data for the the VMs is extracted from the vROps, but only for vSphere machines.

For other platform types, IaaS is used for statistics metrics.

Typical Use Cases

Tenant administrators view metrics for the VMs in the installation, and can initiate a reclamation request for VMs whose lease they want to reclaim.

All VMs that have been accepted for reclamation from their owners are put on a new lease, which expires immediately. After that, after expiration of a specified time, the VMs are deleted from the underlying services. If the time period for owner response has elapsed, the machines are put on a new lease, which is defined in the reclamation request.

Key Concepts


Tenant administrators can choose to use basic metrics or metrics from vROps.

Tenant administrators can use metrics such as low CPU use, low memory use, or low hard disk use to reclaim leases for VMs.

Using the REST API calls for performance endpoints, you can request overall performance metrics or metrics for a specified VM.

Metrics Provider Management Endpoint

The management endpoint used by the vRA installation. You can query the management endoint using the GET /api/management/endpoint/{tenantId} REST API. If the default metrics provider is being used, the response body is empty. If a vROps management endpoint is being used, the vROps management endpoint is returned.

You can also create a metrics provider management endpoint, update it,or delete it.

Endpoint Certificate

The certificate associated with a management endpoint.

Additional Information

For additional information, see the vRA Programming Guide.


Related Documentation

Related SDKs

Related Sample Code