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
n
Offset:
Specifies the number of rows skipped.
Example: curl Command
The following example command displays all the catalog items that you have permission to view.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/catalogItems?limit=10&page
Example: JSON Output
The following JSON output is returned based on the command input.
{
"links" : [ ],
"content" : [{
"@type" : "CatalogItem",
"id" : "6cca9fd9-83b7-4f5d-8884-fb8a005fc656",
"version" : 1,
"name" : "EC2 Blueprint",
"description" : "EC2 blueprint for AMI: amzn-ami-pv-2013.09.2.x86_64-ebs",
"status" : "PUBLISHED",
"organization" : {
"tenantRef" : "sqa",
"tenantLabel" : "SQA",
"subtenantRef" : "b475039a-94dd-4bf3-97f6-8596f8cf8818",
"subtenantLabel" : "Business Group"
},
"providerBinding" : {
"bindingId" : "1701645d-7e43-479f-930c-fbef58d13d50",
"providerRef" : {
"id" : "ba3b18dd-a891-48d2-a3e7-faed239990ed",
"label" : "iaas-service"
}
},
"forms" : null,
"callbacks" : null,
"isNoteworthy" : false,
"dateCreated" : "2015-09-11T18:53:44.474Z",
"lastUpdatedDate" : "2015-09-11T18:55:11.957Z",
"iconId" : "cafe_default_icon_genericCatalogItem",
"catalogItemTypeRef" : {
"id" : "Infrastructure.Cloud",
"label" : "Cloud Machine"
},
"serviceRef" : {
"id" : "5d4ce014-1ee5-41fa-aecd-ec8734f5317a",
"label" : "CLI Service"
},
Programming Guide
VMware, Inc. 79