About the API Use Cases
The following REST API use cases provide the prerequisite, command line options and format, and sample results to help you perform a variety of vRealize Automation functions, such as requesting a machine or creating a reservation. Each includes service examples that provide syntax for the calls referenced in the use case.
- Creating a Tenant
- Requesting a Machine
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Updating Tenancy on a Security Object
- Triggering an Active Directory Synchronization
- Retrieving Health Test Results
- Using SNMP to Monitor vRealize Automation
curl is used for example requests. Request headers required by the API are included in example requests that are not fragments of a larger example. The variable $vRA represents the appliance name.domain name of the vRealize Automation server in all URLs. The variable $tenantId identifies a tenant for the endpoint. Many examples use a fictional tenant identified as rainpole.
Most example responses show only those elements and attributes that are relevant to the operation being discussed. Ellipses (...) indicate omitted content within response bodies.
Postman collections are not used in the API examples, but are available from the Code Samples section for the vRealize Automation API at VMware{code} or, https://code.vmware.com/apis/vrealize-automation.