6.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- 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
- Requesting a Machine By Type
- Request a Machine
- Syntax for Listing Shared and Private Catalog Items
- Syntax for Finding a Catalog Item by Name
- Syntax for Locating the Blueprint Values Required to Construct a Machine Request
- Syntax for Constructing a JSON File For a Machine Request
- Syntax for Requesting a Machine
- Syntax for Viewing All of Your Requests
- Syntax for Finding a Resource by its Request ID
- Syntax for Viewing the Details of a Machine Request
- Request a vCloud Air Machine
- Request an Amazon Machine
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Reprovision a Machine Resource
- 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
- Create a Tenant
- Filtering and Formatting REST API Information
- Related Tools and Documentation
Property Description
statusName Specifies the life cycle status name, such as Active.
catalogItemTypeRef Specifies the type of the catalog item.
serviceRef Specifies the catalog service that contains the catalog item.
iconId Specifies the associated icon representing this item.
organization Specifies the subtenant and/or tenant to which this item belongs
providerBinding Specifies the provider side identifier of this item.
forms Specifies the forms that are associated with catalog items of this type.
callbacks Specifies the callbacks to the provider that are supported by this catalog item.
isNoteworthy Specifies if the catalog item should be highlighted to users for a period of time.
dateCreated Specifies the date that this item was created in the catalog.
lastUpdatedDate Specifies the date that this item was last updated in the catalog.
For sample curl and REST API calls, sample output is provided.
Example: curl Command
The following example command displays the catalog items that you are entitled to view, including
published vCloud Air blueprints, one page at a time with a maximum of 10 items on each page.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/catalogItems?limit=10&page=1
Example: JSON Output
The following JSON output is returned based on the command input.
The following highlighted items, for this example, are required when you submit a request for a vCloud Air
machine.
{
"@type" : "CatalogItem",
"id" : "c2cacf7c-b3c8-47fb-a938-2c09910b6713",
"version" : 1,
"name" : "vApp",
"description" : "",
"status" : "PUBLISHED",
"organization" : {
"tenantRef" : "acx",
"tenantLabel" : "ACX",
"subtenantRef" : null,
"subtenantLabel" : null
},
"providerBinding" : {
"bindingId" : "46548940-eb20-4368-9e73-c1685cda8c64",
"providerRef" : {
"id" : "ba3b18dd-a891-48d2-a3e7-faed239990ed",
Programming Guide
VMware, Inc. 62