## PATCH /api/v2/ssh-keys/{id}

**Rename VPS SSH key**

Rename an account-level SSH key used by VPS deploy/reset flows. Key material is immutable; this PATCH accepts only `name` and returns the same public key ID with the new label.

### Related Endpoints

- `DELETE /api/v2/ssh-keys/{id}`: Delete VPS SSH key
- `GET /api/v2/ssh-keys`: List VPS SSH keys
- `POST /api/v2/ssh-keys`: Create VPS SSH key

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `write:account`
- `Content-Type`: application/json

### Parameters

- `id` (path, string, required): Public account SSH key ID used for VPS deploy/reset flows. Get it from GET /api/v2/ssh-keys `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response. Example: `ssh_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Body

- `name` (string, required) Example: `production-deploy-key`

### Request Examples

#### Rename key

```bash
curl -X PATCH "https://cloud.hostup.se/api/v2/ssh-keys/ssh_01hxa3b4c5d6e7f8g9h0j1k2m3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production-deploy-key"
  }'
```

```json
{
  "name": "production-deploy-key"
}
```

### Response Schema

- `id` (string, optional) Example: `ssh_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `displayId` (string, optional): Compatibility display fallback on VPS-scoped SSH-key reads. Prefer `name` and `fingerprint`. Example: `deploy-key`
- `name` (string, optional) Example: `deploy-key`
- `publicKey` (string, optional) Example: `ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIE9wZW5BUElFeGFtcGxlS2V5TWF0ZXJpYWwxMjM0 ops@example.com`
- `fingerprint` (string,null, optional) Example: `SHA256:8pQ3ExampleFingerprintForDocsOnly`
- `keyType` (string, optional) Example: `ed25519`
  Allowed values: rsa, ed25519, ecdsa, dsa, unknown
- `createdAt` (string,null, optional) Example: `null`
- `lastUsedAt` (string,null, optional): Only present on VPS-scoped SSH-key inventory when upstream reports last use. Example: `null`
- `actions` (object, optional): Present on the account-level SSH-key inventory.
- `actions.canRename` (object, optional)
- `actions.canRename.allowed` (boolean, required) Example: `true`
- `actions.canRename.reason` (string,null, required) Example: `null`
- `actions.canRename.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`
- `actions.canDelete` (object, optional)
- `actions.canDelete.allowed` (boolean, required) Example: `true`
- `actions.canDelete.reason` (string,null, required) Example: `null`
- `actions.canDelete.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`

### Responses

#### 200 - Renamed VPS SSH key.
```json
{
  "id": "ssh_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "name": "production-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
    }
  }
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```
