7.2
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
- Index
{
"key": "keyPairs",
"value": {
"type": "string",
"value": "Per Provisioning Group"
}
}
]
}
}”
The output is a sample location URL, including the new Amazon reservation ID.
Location: https://$host/reservation-service/api/reservations/3289b039-2a11-4ab4-a0bc-
b583e4c6d085
Syntax for Creating an Amazon Reservation
You can use the REST API reservation service to create an Amazon reservation.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/reservation-service/api/reservations
Method Post
$host Species the host name and fully qualied domain name or IP
address of the vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary credentials.
HTTP body The HTTP body describes the reservation to create and calls the
REST API used to create the reservation.
Compose the HTTP body using one of the following methods:
n
Copy the HTTP body from the JSON output from this example
and edit the applicable eld values to compose the HTTP body
input for the command line.
n
Use the API commands in “Syntax for Verifying a Reservation
and Geing Reservation Details,” on page 236, remove the
appropriate ID eld from the HTTP response, and edit the eld
values to compose the HTTP body input for the command line.
Output
The output URL contains the new reservation ID.
Property Description
status When the reservation is successfully created, the HTTP response
status is 201 created.
Header.Location
The HTTP response contains a Location aribute that is formaed as
hps://$host /reservation-service/api/reservations/$reservationId.
$reservationId Species the new reservation ID.
Chapter 3 REST API Use Cases
VMware, Inc. 225