Get VPS guest-agent command state

GET /api/v2/vps/{id}/agent/exec

Without pid, return whether QEMU Guest Agent command execution is available for the VPS.

With pid, poll output for a command started by POST /api/v2/vps/{id}/agent/exec.

Get {id} from GET /api/v2/vps data[].id.

The no-pid availability probe requires read:vm; polling command output requires write:vm because command output may contain sensitive in-guest data.

VPS Services VM

Authentication

Required API scopes: read:vmwrite:vm

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

Context

Related endpoints

POST /api/v2/vps/{id}/agent/exec Run command inside VPS GET /api/v2/vps/{id}/status Get VPS live status GET /api/v2/vps/{id}/console Create VPS console session

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.

Query Parameters

pid integer · Example: 4242

Command process ID returned by POST /api/v2/vps/{id}/agent/exec. Omit to check availability.

Headers

Authorization Bearer <token>

Accept application/json

Responses

200 Availability state when pid is omitted, or command output when pid is present. 2 variants

VpsGuestAgentExecAvailability

available boolean required · Example: true

True when QEMU Guest Agent command execution is available.

reason string · nullable required · Example: null

Human-readable reason when command execution is unavailable.

vmRunning boolean required · Example: true

Convenience flag for rendering. Use available as the action gate.

VpsGuestAgentExecStatus

pid integer required · Example: 4242

exited boolean required · Example: true

True once the command has finished.

exitCode integer · nullable required · Example: 0

Process exit code when available.

stdout string required · Example:

Linux app-01 6.8.0-31-generic x86_64 GNU/Linux

stderr string required · Example:

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. 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

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

For AI assistants

View as Markdown

cURL

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

Response

// Availability probe
{
  "available": true,
  "reason": null,
  "vmRunning": true
}

// Polled command output
{
  "pid": 4242,
  "exited": true,
  "exitCode": 0,
  "stdout": "Linux app-01 6.8.0-31-generic x86_64 GNU/Linux\n",
  "stderr": ""
}

{
  "oneOf": [
    {
      "title": "VpsGuestAgentExecAvailability",
      "type": "object",
      "properties": {
        "available": {
          "type": "boolean",
          "description": "True when QEMU Guest Agent command execution is available."
        },
        "reason": {
          "type": "string",
          "description": "Human-readable reason when command execution is unavailable.",
          "nullable": true
        },
        "vmRunning": {
          "type": "boolean",
          "description": "Convenience flag for rendering. Use `available` as the action gate."
        }
      }
    },
    {
      "title": "VpsGuestAgentExecStatus",
      "type": "object",
      "properties": {
        "pid": {
          "type": "integer"
        },
        "exited": {
          "type": "boolean",
          "description": "True once the command has finished."
        },
        "exitCode": {
          "type": "integer",
          "description": "Process exit code when available.",
          "nullable": true
        },
        "stdout": {
          "type": "string"
        },
        "stderr": {
          "type": "string"
        }
      }
    }
  ]
}