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
Contents
vRealize Automation Programming Guide 7
Updated Information 8
1
Overview of the vRealize Automation REST API 9
REST API Services 9
Using the vRealize Automation REST API 11
About the API Use Cases 12
2
REST API Authentication 13
About HTTP Bearer Tokens 13
Configure the Duration of an HTTP Bearer Token 14
Request an HTTP Bearer Token 14
Syntax for Requesting an HTTP Bearer Token 16
Validate an HTTP Bearer Token 17
Delete an HTTP Bearer Token 18
3
Creating a Tenant 20
Prerequisites for Creating a Tenant 20
Create a Tenant With Parameters Inline 20
Create a Tenant With a JSON File 23
Identity Service Examples for Creating a Tenant 25
Syntax for Displaying Your Current Tenants 26
Syntax for Requesting a New Tenant 28
Syntax for Listing All Tenant Identity Stores 31
Syntax for Linking an Identity Store to the Tenant 33
Syntax for Searching LDAP or Active Directory for a User 37
Syntax for Assigning a User to a Role 38
Syntax for Displaying all Roles Assigned to a User 39
4
Requesting a Machine 42
Request a Machine 42
Catalog Service Examples for Requesting a Machine 44
Syntax for Listing Shared and Private Catalog Items 44
Syntax for Getting Information for a Catalog Item 48
Syntax for Getting a Template Request for a Catalog Item 52
Syntax for Requesting a Machine 55
Syntax for Viewing Details of a Machine Request 59
VMware, Inc.
3