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
JSON Output
The output returns an empty HTTP response body and the host information and key pair ID in the header
statement.
Location:
https://vcac148-084-241.eng.mycompany.com/iaas-proxy-provider/api/keyPairs/56
Copy the location URL into a text editor for future use.
Input
Use the supported input parameters to control the command output.
Input Description
URL https://$vRA/iaas-proxy-provider/api/keyPairs
Method Post
$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.
HTTP Body Contains the HTTP body of the target key pair.
Output
The command output contains property names and values based on the command input parameters.
Parameter Description
status If the command is successful, the HTTP status is 201 Created.
Header.Location The http response should contain a Location attribute with the
following format.
https://$vRA/iaas-proxy-
provider/api/keyPairs/$keypairID
$keypairID Specifies the unique identifier of the new key pair.
Example: curl Command
curl --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$vRA/iaas-proxy-provider/api/keyPairs -d
“
{
"name": "TestKeyPair",
"computeResourceId": "ca4dcca0-85ce-49dd-8371-4ce7c8e2d5e6",
Programming Guide
VMware, Inc. 295