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
Contents
vRealize Automation Programming Guide 6
1
Overview of the vRealize Automation REST API 7
2
REST API Authentication 10
Using HTTP Bearer Tokens 10
Configure the Duration of an HTTP Bearer Token 10
Request an HTTP Bearer Token 11
Validate an HTTP Bearer Token 14
Delete an HTTP Bearer Token 14
3
REST API Use Cases 16
Create a Tenant 17
Syntax for Displaying Your Current Tenants 20
Syntax for Requesting a New Tenant 23
Syntax for Listing All Tenant Identity Stores 26
Syntax for Linking an Identity Store to the Tenant 29
Syntax for Searching LDAP or Active Directory for a User 33
Syntax for Assigning a User to a Role 35
Syntax for Displaying all Roles Assigned to a User 36
Request a Machine 38
Syntax for Listing Shared and Private Catalog Items 40
Syntax for Getting Information for a Catalog Item 43
Syntax for Getting a Template Request for a Catalog Item 47
Syntax for Requesting a Machine 51
Syntax for Viewing Details of a Machine Request 54
Approve a Machine Request 57
Syntax for Listing Work Items 58
Syntax for Getting Work Item Details 65
Syntax for Constructing a JSON File to Approve a Machine Request 69
Syntax for Approving a Submitted Machine Request 73
Syntax for Updating Cost Information 75
List Provisioned Resources 78
Syntax for Displaying Your Provisioned Resources 79
Syntax for Displaying Provisioned Resources by Resource Type 81
Syntax for Displaying All Available Resource Types 84
Syntax for Displaying Provisioned Resources by Business Groups You Manage 86
Syntax for Viewing Machine Details 93
VMware, Inc.
3