Reconcile saved VPS SSH keys (legacy)

POST /api/v2/vps/{id}/actions/reset-ssh-keys

Compatibility action for reconciling a VPS's saved account-key selection.

It does not represent the server's complete SSH access list.

The action reads the live guest file, replaces only exact lines from the prior saved-key selection, preserves every other line and restriction, and fails closed if the live file cannot be verified.

New integrations and user interfaces should use GET/PATCH /api/v2/vps/{id}/ssh-access, which lists and manages actual individual access entries.

VPS Services VM

Authentication

Required API scope: write:vm

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

Context

Related endpoints

GET /api/v2/vps/{id}/ssh-keys List VPS SSH keys POST /api/v2/ssh-keys Create VPS SSH key GET /api/v2/vps/{id} Get VPS details

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Public VPS ID from GET /api/v2/vps data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>

Accept application/json

Content-Type application/json

Body

required

application/json

sshKeyIds array<string> required · Example: ["ssh_01hxa3b4c5d6e7f8g9h0j1k2m3"]

Public saved SSH key IDs from GET /api/v2/vps/{id}/ssh-keys sshKeys[].id. Send [] to clear the legacy saved-key selection. This is not a request to remove every live access entry.

Responses

200 SSH-key reset accepted. 5 fields

accepted boolean · Example: true

keyCount integer · min: 0 · Example: 1

effect string · enum · Example: immediate

Whether the legacy saved-key selection was applied and verified immediately through the guest agent.

immediate

next_boot

managementScope string · enum · Example: saved_key_selection

The compatibility subset controlled by this operation. This is not the server's complete SSH access inventory.

saved_key_selection

unmanagedKeysPreserved boolean · Example: true

True when a live guest-agent reconciliation verified that entries added directly to authorized_keys, including options-prefixed keys, were preserved. False means the key selection was staged for the next boot and preservation is not yet verified.

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; code is vps_not_found. 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

POST https://cloud.hostup.se/api/v2/vps/{id}/actions/reset-ssh-keys

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/reset-ssh-keys" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "sshKeyIds": [
      "ssh_01hxa3b4c5d6e7f8g9h0j1k2m3"
    ]
  }'

Response

{
  "accepted": true,
  "keyCount": 1,
  "effect": "immediate",
  "managementScope": "saved_key_selection",
  "unmanagedKeysPreserved": true
}

{
  "type": "object",
  "properties": {
    "accepted": {
      "type": "boolean"
    },
    "keyCount": {
      "type": "integer",
      "minimum": 0
    },
    "effect": {
      "type": "string",
      "description": "Whether the legacy saved-key selection was applied and verified immediately through the guest agent.",
      "enum": [
        "immediate",
        "next_boot"
      ]
    },
    "managementScope": {
      "type": "string",
      "description": "The compatibility subset controlled by this operation. This is not the server's complete SSH access inventory.",
      "enum": [
        "saved_key_selection"
      ]
    },
    "unmanagedKeysPreserved": {
      "type": "boolean",
      "description": "True when a live guest-agent reconciliation verified that entries added directly to authorized_keys, including options-prefixed keys, were preserved. False means the key selection was staged for the next boot and preservation is not yet verified."
    }
  }
}

Request Body Reset to one SSH key

{
  "sshKeyIds": [
    "ssh_01hxa3b4c5d6e7f8g9h0j1k2m3"
  ]
}