List keypairs

GET /cloud/v2/keypairs

Try it

List keypairs

cURL

curl --request GET \
  --url https://api.gcore.com/cloud/v2/keypairs \
  --header 'Authorization: <api-key>'

200

{
  "count": 1,
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "public_key": "<string>",
      "shared_in_project": true,
      "state": "ACTIVE",
      "created_at": "2023-11-07T05:31:56Z",
      "fingerprint": "86:75:ce:e7:e9:1e:f0:79:ec:6f:d8:92:9b:43:fc:4d",
      "private_key": "<private_key>",
      "project_id": 1
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

project_id · integer | null

Project ID. It's required with rights lower than a cloud administrator.

Example:

100

user_id · integer | null

User ID. To use it, you need set project id or use cloud administrator rights.

Example:

5

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

results · Keypair response object · object[] · required

Objects

Show child attributes

results. id · string · required

Key ID, equal to sshkey_name

results. name · string · required

Keypair name

Required string length: 1 - 255

results. public_key · string · required

Public part of the key. To generate public and private keys in the platform, do not specify the parameter in the request body.

results. shared_in_project · boolean · required

Keypair is shared for all users in the project

results. state · enum<string> · required

Keypair state

Available options: ACTIVE, DELETING

results. created_at · string<date-time> | null

Keypair creation datetime

results. fingerprint · string | null

Key fingerprint

Example:

"86:75:ce:e7:e9:1e:f0:79:ec:6f:d8:92:9b:43:fc:4d"

results. private_key · string | null

Private part of the key

Example:

"<private_key>"

results. project_id · integer | null

Project ID

Example:

1