## POST /api/v2/vps/{id}/actions/config

**Change VPS resource options**

Preview or commit configurable-option changes for one VPS without changing its plan. Get `{id}` from `GET /api/v2/vps` `data[].id`. First call `GET /api/v2/vps/{id}/actions/upgrade` and read `configurableOptions[].key`, limits, constraints, and action gates. Send canonical option keys under `resources`, for example `{ "bandwidthGb": 4096 }` to add bandwidth only or `{ "snapshotSlots": 3 }` to buy/increase snapshot capacity when the option is returned. `billingCycle` is allowed only with `dryRun: true`; committed billing-cycle changes belong to `/actions/billing-cycle`.

### Related Endpoints

- `GET /api/v2/vps/{id}/actions/upgrade`: Get VPS upgrade options
- `POST /api/v2/vps/{id}/actions/upgrade`: Change VPS plan
- `GET /api/v2/billing/invoices`: List invoices

### Headers

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

### Parameters

- `id` (path, string, required): 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. Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Body

- `resources` (object, required): Canonical configurable-option keys from `GET /actions/upgrade` `configurableOptions[].key` mapped to primitive values. Common keys include `bandwidthGb`, `backupSlots`, `snapshotSlots`, `ipv4Count`, `ipv6`, and `additionalStorageGb`. Example: `{"bandwidthGb":4096}`
- `billingCycle` (string, optional): Preview-only cycle hint. If present on a commit request, the route returns 400 with recovery steps. Example: `monthly`
  Allowed values: monthly, quarterly, semiannually, annually, biennially, triennially
- `dryRun` (boolean, optional): When true, return pricing without committing the resource change. Example: `true`
- `cancelExistingInvoice` (boolean, optional): Use only when a 409 `existing_invoice_blocking` response suggests resending with this flag. Example: `true`

### Request Examples

#### Preview adding bandwidth only

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": {
      "bandwidthGb": 4096
    },
    "dryRun": true
  }'
```

```json
{
  "resources": {
    "bandwidthGb": 4096
  },
  "dryRun": true
}
```

#### Commit adding bandwidth only

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": {
      "bandwidthGb": 4096
    }
  }'
```

```json
{
  "resources": {
    "bandwidthGb": 4096
  }
}
```

#### Preview adding attachable block storage

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": {
      "additionalStorageGb": 200
    },
    "dryRun": true
  }'
```

```json
{
  "resources": {
    "additionalStorageGb": 200
  },
  "dryRun": true
}
```

#### Commit adding attachable block storage

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": {
      "additionalStorageGb": 200
    }
  }'
```

```json
{
  "resources": {
    "additionalStorageGb": 200
  }
}
```

#### Preview adding snapshot slots

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": {
      "snapshotSlots": 3
    },
    "dryRun": true
  }'
```

```json
{
  "resources": {
    "snapshotSlots": 3
  },
  "dryRun": true
}
```

#### Commit adding snapshot slots

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": {
      "snapshotSlots": 3
    }
  }'
```

```json
{
  "resources": {
    "snapshotSlots": 3
  }
}
```

### Response Schema

- `dryRun` (boolean, optional) Example: `true`
- `priceChange` (object, optional)
- `priceChange.amount` (number, required) Example: `40`
- `priceChange.recurringAmount` (number, required) Example: `40`
- `priceChange.additionalRecurringAmount` (number,null, required) Example: `40`
- `priceChange.currencyCode` (string, required) Example: `SEK`
- `paymentInvoice` (object,null, optional)
- `actions` (object, optional)
- `actions.canCommit` (object, optional)
- `actions.canCommit.allowed` (boolean, required) Example: `true`
- `actions.canCommit.reason` (string,null, required) Example: `null`
- `actions.canCommit.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`

### Responses

#### 200 - Resource-option preview or committed result.
```json
{
  "dryRun": true,
  "priceChange": {
    "amount": 40,
    "recurringAmount": 40,
    "additionalRecurringAmount": 40,
    "currencyCode": "SEK"
  },
  "paymentInvoice": null,
  "actions": {
    "canCommit": {
      "allowed": true,
      "reason": null,
      "code": "pending_order"
    }
  }
}
```

#### 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"
}
```

#### 409 - Conflict. See the Problem Details `code` for the route-specific blocker and recovery fields.
```json
{
  "status": 409,
  "instance": "/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/config",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "type": "https://developer.hostup.se/errors/existing_invoice_blocking",
  "title": "Existing invoice blocks plan change",
  "detail": "There is already an unpaid invoice #202600001 for this service. Pay it, or retry with `cancelExistingInvoice: true`.",
  "code": "existing_invoice_blocking",
  "existingInvoice": {
    "id": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
    "number": "202600001",
    "amount": 159,
    "currencyCode": "SEK"
  },
  "recovery": {
    "action": "retry_with_cancel_existing_invoice",
    "suggestedBody": {
      "cancelExistingInvoice": true
    }
  }
}
```

#### 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"
}
```
