• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Nova
  5. Key and Password Management
  6. Querying SSH Key Pairs

Querying SSH Key Pairs

Function

This API is used to query SSH key pairs.

URI

GET /v2.1/{project_id}/os-keypairs

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

Request

N/A

Response

Response parameters

Table 2 describes the response parameters.
Table 2 Response parameters

Parameter

Type

Description

keypairs

List data structure

Specifies key pairs. For details, see Table 3.

Table 3 keypairs field description

Parameter

Type

Description

keypair

Dictionary data structure

Specifies details about a key pair. For details, see Table 4.

Table 4 keypair field description

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 field is supported in microversions later than 2.2.

public_key

String

Specifies information about the public key.

Examples

  • Example response
    {
        "keypairs": [
    {
                "keypair": {
                    "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a",
                    "name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a",
                    "type": "ssh",
                    "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova\n"
                    }
            }
        ]
    }

Returned Values

See General Request Returned Values.