cdnca

API reference

/v1/admin/maintenance-upgrade-status

1 operations

← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures

MethodPathSummaryAuth
GET/v1/admin/maintenance-upgrade-statusRead authoritative maintenance upgrade statusSession

Contract file：api/control-maintenance-upgrade-status.openapi.yaml

Operation details

GET /v1/admin/maintenance-upgrade-status

Read authoritative maintenance upgrade status

operationId
readMaintenanceUpgradeStatus
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

All of：control.upgrades.read

Description (from the contract)

Requires a platform identity with control.upgrades.read. Repeated node_id parameters additionally require nodes.read. Membership and permissions are checked against current database state. Duplicate IDs, noncanonical UUIDs, more than 100 IDs and unknown query parameters are rejected. Nodes are sorted by ID and missing or foreign-scope nodes return 404. The main version comes from the running Control API build, never rollout history or configured version. Candidate metadata is verified against installation-bound signatures, current entitlement and release policy; it does not authorize execution. No grants, plans, reservations or audit records are written by this request.

Parameters

readMaintenanceUpgradeStatus Parameters
NameInTypeRequiredDescription
node_idqueryarray<string(uuid)>NoOptional inventory batch; requires nodes.read.

Responses

readMaintenanceUpgradeStatus Responses
StatusDescription
200Fresh read-only status; unavailable dependencies are explicit states.

Fields：data: object

400Invalid query or node IDs.
401Authentication required.
403Platform scope or current permissions denied.
404A requested node is not visible in this scope.
503Required local runtime is unavailable.

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 404 The resource does not exist or belongs to another tenant.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list