List VPS SSH keys

GET /api/v2/ssh-keys

List the caller's account SSH-key inventory used when ordering, rebuilding, or resetting SSH access on VPS instances. This is not the shared-hosting authorized-key list; use /api/v2/shared-hosting/{accountId}/ssh-keys for hosting-account SSH access.

VPS Services VM

Authentication

Required API scope: read:vm

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Related endpoints

POST /api/v2/ssh-keys Create VPS SSH key GET /api/v2/vps/{id}/ssh-keys List VPS SSH keys POST /api/v2/vps/{id}/actions/reset-ssh-keys Reset VPS SSH keys

Query Parameters

limit integer · min: 1 · max: 100 · default: 20 · Example: 20

Page size from 1 to 100. Defaults to 20. Values above 100 are rejected with 400 invalid_pagination_limit.

cursor string · Example: eyJsYXN0SWQiOiJzc2hfMDFoeGEzYjRjNWQ2ZTdmOGc5aDBqMWsybTMifQ

Opaque cursor from nextCursor for the next page.

Headers

Authorization Bearer <token>

Accept application/json

Responses

200 Cursor-paginated VPS SSH key inventory. 3 fields

data array<object>

data[].id string required · Example: ssh_01hxa3b4c5d6e7f8g9h0j1k2m3

data[].displayId string · Example: deploy-key

Compatibility display fallback on VPS-scoped SSH-key reads. Prefer name and fingerprint.

data[].name string required · Example: deploy-key

data[].publicKey string required · Example: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIE9wZW5BUElFeGFtcGxlS2V5TWF0ZXJpYWwxMjM0 ops@exampl...

data[].fingerprint string · nullable required · Example: SHA256:8pQ3ExampleFingerprintForDocsOnly

Nullable: may be null when not applicable.

data[].keyType string · enum required · Example: ed25519

rsa

ed25519

ecdsa

dsa

unknown

data[].createdAt string · nullable required · Example: null

Nullable: may be null when not applicable.

data[].lastUsedAt string · nullable · Example: null

Only present on VPS-scoped SSH-key inventory when upstream reports last use.

data[].actions object

Present on the account-level SSH-key inventory.

data[].actions.canRename object

data[].actions.canRename.allowed boolean required · Example: true

data[].actions.canRename.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

data[].actions.canRename.code string · nullable · Example: pending_order

Machine-readable reason code when an action is blocked.

data[].actions.canDelete object

data[].actions.canDelete.allowed boolean required · Example: true

data[].actions.canDelete.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

data[].actions.canDelete.code string · nullable · Example: pending_order

Machine-readable reason code when an action is blocked.

hasMore boolean · Example: false

nextCursor string · nullable · Example: null

400 Invalid request. The response body is an RFC 7807 Problem Details document. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

401 Unauthorized. Authentication is required. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

403 Forbidden. The caller lacks a required scope or does not own the resource. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

404 Not found. The resource does not exist or is not owned by the caller. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

500 Internal error. Retry later or contact support if the issue persists. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

GET https://cloud.hostup.se/api/v2/ssh-keys

For AI assistants

View as Markdown

cURL

curl -X GET "https://cloud.hostup.se/api/v2/ssh-keys" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "ssh_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "name": "deploy-key",
      "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIE9wZW5BUElFeGFtcGxlS2V5TWF0ZXJpYWwxMjM0 ops@example.com",
      "fingerprint": "SHA256:8pQ3ExampleFingerprintForDocsOnly",
      "keyType": "ed25519",
      "createdAt": null,
      "actions": {
        "canRename": {
          "allowed": true,
          "reason": null
        },
        "canDelete": {
          "allowed": true,
          "reason": null
        }
      }
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "displayId": {
            "type": "string",
            "description": "Compatibility display fallback on VPS-scoped SSH-key reads. Prefer `name` and `fingerprint`."
          },
          "name": {
            "type": "string"
          },
          "publicKey": {
            "type": "string"
          },
          "fingerprint": {
            "type": "string",
            "nullable": true
          },
          "keyType": {
            "type": "string",
            "enum": [
              "rsa",
              "ed25519",
              "ecdsa",
              "dsa",
              "unknown"
            ]
          },
          "createdAt": {
            "type": "string",
            "nullable": true
          },
          "lastUsedAt": {
            "type": "string",
            "description": "Only present on VPS-scoped SSH-key inventory when upstream reports last use.",
            "nullable": true
          },
          "actions": {
            "type": "object",
            "description": "Present on the account-level SSH-key inventory.",
            "properties": {
              "canRename": {
                "type": "object",
                "properties": {
                  "allowed": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "string",
                    "nullable": true
                  },
                  "code": {
                    "type": "string",
                    "description": "Machine-readable reason code when an action is blocked.",
                    "nullable": true
                  }
                }
              },
              "canDelete": {
                "type": "object",
                "properties": {
                  "allowed": {
                    "type": "boolean"
                  },
                  "reason": {
                    "type": "string",
                    "nullable": true
                  },
                  "code": {
                    "type": "string",
                    "description": "Machine-readable reason code when an action is blocked.",
                    "nullable": true
                  }
                }
              }
            }
          }
        }
      }
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextCursor": {
      "type": "string",
      "nullable": true
    }
  }
}