System

Use these endpoints to manage System operations on a Crate Operator host. The reference below includes request attributes, response shapes, and executable request examples.

The System object

Result of checking for available system package updates.

Optional attributes

packages array<string>

List of packages with available updates.

reboot_required boolean

Whether a reboot is required after updates.

regular_updates integer

Number of regular (non-security) package updates.

security_updates integer

Number of security-related package updates.

updates_available boolean

Whether any updates are available.

POST /v1/system/check-updates

Check for available system package updates

Responses

200 OK

500 Server Error

Request cURL

POST /v1/system/check-updates

curl --request POST 'http://localhost:8080/v1/system/check-updates' \
  --header 'X-API-Key: <token>'

Response JSON

{
  "packages": [
    "string"
  ],
  "reboot_required": true,
  "regular_updates": 1,
  "security_updates": 1,
  "updates_available": true
}

POST /v1/system/apply-updates

Apply system package updates

Request attributes

Required attributes

update_type string

Type of update to apply (`security` for safe upgrades only, `full` for all available upgrades).

securityfull