Create Cloud VPS PAYG deployment

POST /api/v2/vps/payg/deployments

Create a pay-as-you-go Cloud VPS deployment.

This is the PAYG creation endpoint, not the regular fixed-cycle VPS order endpoint.

name is optional; when omitted, the server generates a friendly hostname.

When provided, it must be 3-253 characters using letters, numbers, hyphens, and dots.

region is required.

Use GET /api/v2/vps/payg/deployments and GET /api/v2/vps/payg/limits first to confirm actions.canDeploy.allowed, choose a valid region, and stay within account limits.

If the account is not eligible, the API returns 403 with the blocking reason.

The returned vpsId is managed afterwards through the standard /api/v2/vps/{id} operational endpoints.

Cloud VPS PAYG Deployments

Authentication

Required API scope: write:billing

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

Context

Headers

Authorization Bearer <token>
Accept application/json
Content-Type application/json

Body

required
application/json
name string · Example: swift-falcon.local
cpuCores integer · min: 1 · max: 32 required · Example: 2
memoryGb integer · min: 1 · max: 256 required · Example: 4
storageGb integer · min: 50 · max: 2000 required · Example: 80
region string required · Example: stockholm

Responses

201 PAYG deployment created.
status string · enum required · Example: provisioning
provisioning
vpsId string required · Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3
orderId string required · Example: ord_01hxa3b4c5d6e7f8g9h0j1k2m3
invoiceId string required · Example: inv_01hxa3b4c5d6e7f8g9h0j1k2m3
deployment object required
deployment.name string required · Example: swift-falcon.local
deployment.region string required · Example: stockholm
deployment.resources object required
deployment.resources.cpuCores integer required · Example: 2
deployment.resources.memoryGb integer required · Example: 4
deployment.resources.storageGb integer required · Example: 80
400 Invalid request. The response body is an RFC 7807 Problem Details document.
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.
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 The account cannot create pay-as-you-go deployments yet. code is the primary blocker: country_not_supported, insufficient_trusted_history, no_card_on_file, not_verified, no_cloud_access, or payg_access_unavailable. The blockerReasons extension lists every blocking reason and actions.canDeploy carries the human-readable explanation.

No response body

404 Not found. The resource does not exist or is not owned by the caller.
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.
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.
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/payg/deployments
For AI assistants
View as Markdown
cURL 
curl -X POST "https://cloud.hostup.se/api/v2/vps/payg/deployments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "cpuCores": 2,
    "memoryGb": 4,
    "storageGb": 80,
    "region": "stockholm"
  }'
Response 
{
  "status": "provisioning",
  "vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "orderId": "ord_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "invoiceId": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "deployment": {
    "name": "swift-falcon.local",
    "region": "stockholm",
    "resources": {
      "cpuCores": 2,
      "memoryGb": 4,
      "storageGb": 80
    }
  }
}
Request Body Deploy PAYG Cloud VPS 
{
  "cpuCores": 2,
  "memoryGb": 4,
  "storageGb": 80,
  "region": "stockholm"
}