7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating 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
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for 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
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
n
Syntax for Creating an Amazon Reservation
POST /api/reservations with a reservationTypeID for Amazon, creates an Amazon
reservation.
n
Syntax for Creating a vCloud Air Reservation
POST /api/reservations with a reservationTypeID for vCloud Air, creates a vCloud Air
reservation.
n
Syntax for Verifying a Reservation and Getting Reservation Details
GET /api/reservations/{id} retrieves a vRealize Automation reservation. After you create a
reservation, you can use the reservation ID to verify that the reservation exists. You can also use the
ID to get information about the reservation in preparation for updating or deleting it.
n
Syntax for Displaying a List of Supported Reservation Types
GET /api/reservations/types displays a list of supported vRealize Automation reservation
types.
n
Syntax for Updating a Reservation
PUT /api/reservations/{id} updates an existing reservation with a given ID.
n
Syntax for Deleting a Reservation
DELETE /api/reservations/{id} deletes an existing reservation with the given ID.
Syntax for Displaying a List of Reservations
GET /api/reservations displays a list of existing vRealize Automation reservations. You can use this
list to obtain the required reservation ID value in preparation for updating or deleting a reservation.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$vRA/reservation-service/api/reservations
Method Get
$vRA Specifies the appliance name and fully qualified domain name, or IP
address of the vRealize Automation server.
$token Specifies a valid HTTP bearer token with necessary credentials.
Output
The command output contains property names and values based on the command input parameters.
Programming Guide
VMware, Inc. 193