7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Requesting a Machine
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for Working With Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
About the API Use Cases
While the vRealize Automation API Reference contains a menu that lists all REST API service calls, it
does not document use cases. The Programming Guide provides frequently used use cases including
sample requests and responses.
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.
n
Chapter 3 Creating a Tenant
n
Chapter 4 Requesting a Machine
n
Chapter 5 Approving a Machine Request
n
Chapter 6 Listing Provisioned Resources
n
Chapter 7 Managing Provisioned Deployments
n
Chapter 8 Working with Reservations
n
Chapter 9 Working with Reservation Policies
n
Chapter 10 Working with Key Pairs
n
Chapter 11 Working with Network Profiles
n
Chapter 12 Getting a List of Available IP Ranges
n
Chapter 13 Importing and Exporting Content
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.
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.
Programming Guide
VMware, Inc. 12