Get VPS cancellation status

Return the current cancellation state for one VPS. Get {id} from GET /api/v2/vps data[].id. This endpoint returns 200 with status: "none" when no cancellation exists instead of returning 404. If revokable is true, call DELETE /api/v2/vps/{id}/cancellation to remove the pending or scheduled cancellation.

VPS Services VM

Authentication

Required API scope: read:vm

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Related endpoints

POST /api/v2/vps/{id}/actions/cancel Cancel VPS DELETE /api/v2/vps/{id}/cancellation Remove VPS cancellation GET /api/v2/cancellations List service cancellations

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

Accept Example

Content-Type Example

Responses

200 VPS cancellation status.

vpsId string · Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Public VPS ID from `GET /api/v2/vps` `data[].id`.

status string · enum · Example: scheduled

`none` means no cancellation record exists; the status endpoint still returns 200 with the stable cancellation shape.

pending

scheduled

completed

revoked

none

cancelledAt stringnull · Example: 2026-04-27T12:00:00.000Z

When the cancellation request was recorded, if known.

scheduledAt stringnull · Example: 2026-05-27T00:00:00.000Z

Effective cancellation date if known. For immediate cancellation this may match `cancelledAt`.

reason stringnull · Example: Moving to different provider

Stored cancellation reason, or null when no cancellation exists.

cancelType stringnull · enum · Example: end_of_period

Requested cancellation timing, or null when no cancellation exists or the stored record did not expose timing.

immediate

end_of_period

revokable boolean · Example: true

True while the cancellation is pending or scheduled and can be removed with DELETE `/api/v2/vps/{id}/cancellation`.

cancelledPendingOrder boolean · Example: true

Present only when the service was still a pending order and the API cancelled the pending order instead of creating a service cancellation.

cancelledOrderId string · Example: ord_01hxa3b4c5d6e7f8g9h0j1k2m3

Public order ID when `cancelledPendingOrder` is true.

cancellationLookupPending boolean · Example: true

Present only when the cancellation request was accepted but the stored cancellation record was not readable yet. Poll GET `/api/v2/vps/{id}/cancellation` shortly after receiving this state.

submissionAccepted boolean · Example: true

Present with `cancellationLookupPending` to confirm the cancellation request was accepted.

notice object

notice.code string · enum required · Example: cancellation_record_pending

pending_order_cancelled

cancellation_record_pending

notice.detail string required · Example: Cancellation request accepted, but the stored cancellation record is not available yet....

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 Forbidden. The caller lacks a required scope or does not own the resource.

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.

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

GET https://cloud.hostup.se/api/v2/vps/{id}/cancellation

For AI assistants

View as Markdown

cURL

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

Response

{
  "vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "status": "none",
  "cancelledAt": null,
  "scheduledAt": null,
  "reason": null,
  "cancelType": null,
  "revokable": false
}

{
  "type": "object",
  "properties": {
    "vpsId": {
      "type": "string",
      "description": "Public VPS ID from `GET /api/v2/vps` `data[].id`."
    },
    "status": {
      "type": "string",
      "description": "`none` means no cancellation record exists; the status endpoint still returns 200 with the stable cancellation shape.",
      "enum": [
        "pending",
        "scheduled",
        "completed",
        "revoked",
        "none"
      ]
    },
    "cancelledAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the cancellation request was recorded, if known."
    },
    "scheduledAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "Effective cancellation date if known. For immediate cancellation this may match `cancelledAt`."
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stored cancellation reason, or null when no cancellation exists."
    },
    "cancelType": {
      "type": [
        "string",
        "null"
      ],
      "description": "Requested cancellation timing, or null when no cancellation exists or the stored record did not expose timing.",
      "enum": [
        "immediate",
        "end_of_period",
        null
      ]
    },
    "revokable": {
      "type": "boolean",
      "description": "True while the cancellation is pending or scheduled and can be removed with DELETE `/api/v2/vps/{id}/cancellation`."
    },
    "cancelledPendingOrder": {
      "type": "boolean",
      "description": "Present only when the service was still a pending order and the API cancelled the pending order instead of creating a service cancellation."
    },
    "cancelledOrderId": {
      "type": "string",
      "description": "Public order ID when `cancelledPendingOrder` is true."
    },
    "cancellationLookupPending": {
      "type": "boolean",
      "description": "Present only when the cancellation request was accepted but the stored cancellation record was not readable yet. Poll GET `/api/v2/vps/{id}/cancellation` shortly after receiving this state."
    },
    "submissionAccepted": {
      "type": "boolean",
      "description": "Present with `cancellationLookupPending` to confirm the cancellation request was accepted."
    },
    "notice": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "pending_order_cancelled",
            "cancellation_record_pending"
          ]
        },
        "detail": {
          "type": "string"
        }
      }
    }
  }
}