Skip to main content

Get key pairs

Contributors netapp-ranuk

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:

Get key pairs for single node

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

Step 1. Get the region

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

Step 2. Get the key pairs

You can issue the REST API call to retrieve the key pairs.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

GET

/occm/api/vsa/metadata/key-pairs
Curl example
curl --request GET \
--location "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"
Additional input parameters

In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.

Parameter Type Required Description

<REGION> region

Query

Yes

Identifies the region of the working environment

roleArn

Query

No

Identifies the AMazon resource name for the connection's role.

cloudProviderAccountId

Query

No

Identifies the cloud provider account ID.
JSON output example

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

[
    "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.

Step 1. Get the region

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

Note Ensure that you choose the path value for the HA pair while performing the Get Regions workflow.

Step 2. Get the key pairs

You can issue the REST API call to retrieve the key pairs.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

GET

/occm/api/aws/ha/metadata/key-pairs
Curl example
curl --request GET \
--location "https://cloudmanager.cloud.netapp.com/occm/api/aws/ha/metadata/key-pairs?region=<REGION>" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>" \
--header "Content-Type: application/json"
Additional input parameters

In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.

Parameter Type Required Description

<REGION> region

Query

Yes

Identifies the region of the working environment

roleArn

Query

No

Identifies the AMazon resource name for the connection's role.

cloudProviderAccountId

Query

No

Identifies the cloud provider account ID.
JSON output example

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

[
    "Developers_Virginia",
    "gfcqa",
    "kubernetes-net6vbp8sd",
    "kubernetes-netpn77b32",
    "occm_qa"
]