7.1
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create 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
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- 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
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
Related Tools and
Documentation 4
In addition to the provided use case code snippets, you can expand your options for working with the
vRealize Automation REST API by using related tools and documentation.
You can use the vRealize CloudClient to simplify your interaction with the vRealize Automation REST
API. You can also use third party tools such as Chrome Developer Tools or Firebug to further expand your
vRealize Automation REST API programming options.
For a complete list and description of available vRealize Automation REST API service calls and their
usage, see the Swagger documentation for the product.
This chapter includes the following topics:
n
Using the vRealize Automation API Reference
n
View Reference Information for an API
n
Using vRealize CloudClient
n
Using Third Party Tools
Using the vRealize Automation API Reference
The vRealize Automation API Reference describes all the available vRealize Automation REST API
services calls that you can use to configure and manage vRealize Automation programmatically.
To use the vRealize Automation REST API service reference documentation effectively, you must know
which service and resource to use. See Chapter 1 Overview of the vRealize Automation REST API for a
complete list of services and their descriptions. If you need more information, click one of the linked
service topics for a detailed description of the service and a list of the tasks that you can perform with it.
While the Programming Guide contains frequently used use cases, it does not document all the available
service calls and tasks. For a complete description of all the available vRealize Automation REST API
services, see the vRealize Automation API Reference, which contains a menu that lists the
vRealize Automation services and allows you to select documentation for each service. The vRealize
Automation API Reference is available at the following locations:
n
In your running vRealize Automation installation at the following URL:
https://$host/component-registry/services/docs
The $host denotes the host name of the machine where vRealize Automation is installed.
VMware, Inc.
385