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
Parameter Description
URL https://$host/reservation-service/api/reservations/$reservationId
Method Put
$host Specifies the host name and fully qualified domain name or IP address of
the vRealize Automation identity server.
$token Specifies a valid HTTP bearer token with necessary credentials.
$reservationId Specifies the unique identifier of the reservation to update. For information
about how to obtain the reservation ID, see Syntax for Displaying a List of
Reservations.
HTTP body Contains the JSON information for the reservation, including the updated
data for the parameters that you want to update.
Most of this JSON string information is obtained by displaying the existing
details of the $reservationId. See Syntax for Verifying a Reservation and
Getting Reservation Details. The rest of the JSON string information is
obtained by using an API command to get the ID of the parameter you
want to update.
For example, to update the reservation to use a different compute
resource than the one currently specified, replace the computeResource
value of the exiting reservation with a new computeResource value in the
command's HTTP input.
Output
If the command is successful, the HTTP response body is empty except for a 204 No Content status
statement.
Example: curl Command
The following example command updates the reservation with an ID of 94d74105-831a-4598-8f42-
efd590fea15c to use compute resource ID 047e00f5-5424-4ed2-a751-4a334aeaff54.
curl –X PUT--insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$host/reservation-service/api/reservations/94d74105-831a-4598-8f42-efd590fea15c –d
“
{
"id": "94d74105-831a-4598-8f42-efd590fea15c",
"name": "TestReservation",
"reservationTypeId": "Infrastructure.Reservation.Virtual.vSphere",
"tenantId": "qe",
"subTenantId": "ef58f604-528d-4441-a219-4725bead629b",
"enabled": true,
"priority": 3,
"reservationPolicyId": "b71c3a5f-087a-4d9e-9a56-fab785a3d128",
"alertPolicy": {
"enabled": true,
"frequencyReminder": 20,
"emailBgMgr": false,
"recipients": ["user1@mycompany.com",
"user2@mycompany.com"],
Programming Guide
VMware, Inc. 297