Querying SSH Key Pairs¶
Function¶
This API is used to query SSH key pairs.
URI¶
GET /v2.1/{project_id}/os-keypairs
GET /v2/{project_id}/os-keypairs
Table 1 describes the parameters in the URI.
Parameter | Mandatory | Description |
---|---|---|
project_id | Yes | Specifies the project ID. |
Request¶
None
Response¶
Table 2 describes the response parameters.
Parameter | Type | Description |
---|---|---|
keypairs | Array of objects | Specifies key pairs. For details, see Table 3. |
Parameter | Type | Description |
---|---|---|
keypair | Object | Specifies details about a key pair. For details, see Table 4. |
Parameter | Type | Description |
---|---|---|
fingerprint | String | Specifies fingerprint information about the key pair. |
name | String | Specifies the key pair name. |
type | String | Specifies the key type, which is ssh by default. This parameter is supported in microversion 2.2 and later. |
public_key | String | Specifies information about the public key. |
Example Request¶
Query the list of SSH key pairs.
GET https://{endpoint}/v2/{project_id}/os-keypairs
GET https://{endpoint}/v2.1/{project_id}/os-keypairs
Example Response¶
{
"keypairs": [
{
"keypair": {
"fingerprint": "15:b0:f8:b3:f9:48:63:**:**:**:**:**:**:**:**:**",
"name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a",
"type": "ssh",
"public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79Kkl****************************************************************************************************************************************************** Generated-by-Nova\n"
}
}
]
}