Get key pairs

05/22/2023 Contributors

You can use the key pairs endpoint to retrieve the AWS key pairs for specific regions.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Single Node
HA pair

Get key pairs for single node

You can use this workflow to retrieve the key pairs for a single node working environment.

1. Get the region

Perform the workflow Get regions and choose the code value of the required region for the region query parameter.

2. Get the key pairs

HTTP method	Path
GET	/occm/api/vsa/metadata/key-pairs

curl example

curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/vsa/metadata/key-pairs?region=<REGION>' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>' --header 'Content-Type: application/json'

Input

Query parameter:

<REGION> region

Optional parameters for filter:

roleArn: String
cloudProviderAccountId: String

Output

The output shows the AWS user key pairs for a specific region.

JSON output example
```
[
    "Developers_Virginia",
    "gfcqa",
    "kubernetes-net6vbp8sd",
    "kubernetes-netpn77b32",
    "occm_qa"
]
```

Get key pairs for high availability pair

You can use this workflow to retrieve the key pairs for an HA working environment.