Skip to main content

Keypairs

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Getting user keypairs successful
keypairs object[]

An array of keypairs objects, containing details on your existing SSH key pairs.

  • Array [
  • idinteger

    Unique numeric identifier for the SSH key pair.

    Example: 4501
    namestring

    Name of the SSH key pair.

    Example: example-keypair
    environment object

    Environment the SSH key pair belongs to.

    idinteger

    Unique numeric identifier for the environment.

    Example: 6190
    namestring

    Name of the environment.

    Example: example-environment
    regionstring

    Region the environment is in: CANADA-1, NORWAY-1, or US-1.

    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the environment was created.

    features object

    Feature flags enabled in the environment.

    network_optimisedboolean

    Whether high-speed networking is enabled for the environment.

    Example: false
    green_statusstring

    Indicator of how much of the region's capacity is running on green energy.

    Possible values: [GREEN, PARTIALLY_GREEN, NOT_GREEN]

    Example: GREEN
    public_keystring

    OpenSSH-format public key.

    Example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOu6TJudyoheKvyDdnr8HYCBNjJVT79bq9EGuDHdR3e3 [email protected]
    fingerprintstring

    MD5 or SHA256 fingerprint of the public key.

    Example: ff:00:4b:02:8e:43:b6:75:03:7c:52:52:df:82:9d:58
    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the SSH key pair was created.

    Example: 2026-05-07T11:47:30Z
  • ]
  • pageintegernullable

    1-indexed page number of the current result set.

    page_sizeintegernullable

    Number of items per page in the current result set.

    countinteger

    Number of items returned in the current page.

    Example: 6
    Keypairs
    {
    "status": true,
    "message": "Getting user keypairs successful",
    "keypairs": [
    {
    "id": 4501,
    "name": "example-keypair",
    "environment": {
    "id": 6190,
    "name": "example-environment",
    "region": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "features": {
    "network_optimised": false,
    "green_status": "GREEN"
    }
    },
    "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOu6TJudyoheKvyDdnr8HYCBNjJVT79bq9EGuDHdR3e3 [email protected]",
    "fingerprint": "ff:00:4b:02:8e:43:b6:75:03:7c:52:52:df:82:9d:58",
    "created_at": "2026-05-07T11:47:30Z"
    }
    ],
    "page": 0,
    "page_size": 0,
    "count": 6
    }