DescribeKeyPairs

GET /?Action=DescribeKeyPairs
Description

Describes one or more of your keypairs.
You can use the Filter.N parameter to filter the described instances on the following properties:

  • fingerprint: The fingerprint of the keypair.

  • key-name: The name of the keypair.

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Body parameter

Required: false
Name: DescribeKeyPairsRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeKeyPairs \
  --Filter.1.Name "key-name" \
  --Filter.1.Value.1 "Keypair1"

false

Filter

KeyName.N

One or more keypair names.

false

string

Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeKeyPairsResult

Response 200

Response 200

Name Description Required Schema Default Example

keySet.N

Information about one or more keypairs.

false

KeyPairInfo

requestId

The ID of the request.

false

string