Query a Key Pair Example

GET /api/keyPairs/{id} queries a key pair that is available for the vRealize Automation tenant administrator.

curl Command

The following example command queries a key pair.

curl --insecure -H "Accept:application/json" 
-H "Authorization: Bearer $token" 
https://$vRA/iaas-proxy-provider/api/keyPairs/26

JSON Output

The following JSON output is returned based on the command input.

{
  "id": 26,
  "name": "TestKeyPair",
  "computeResourceId": "ca4dcca0-85ce-49dd-8371-4ce7c8e2d5e6",
  "secretKey": ""
} 

Input

Use the supported input parameters to control the command output.

Parameters Description

URL

https://$vRA/iaas-proxy-provider/api/keyPairs/$ids

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.

$id: Specifies the unique identifier of the key pair.

Output

The command output contains property names and values based on the command input parameters.

Parameters Description
$id: Specifies the unique identifier of the key pair.
$name: Specifies the name of the key pair.
$computeResourceId: Specifies the complete resource ID that is bound to the key pair.
$secretKey: Specifies the secret key for the key pair.