Sign in
instance

Read one local updater job and reconcile its terminal audit outcome.

Changed on
get/api/v1/instance/updates/{job}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/updates/{job}
  • Auth: HTTP bearer

Response

Durable helper-owned update state.

idstring required

A prefixed UUIDv7, e.g. org_0198….

backend'flux' | 'compose' | 'systemd' required
versionstring required
state'queued' | 'running' | 'succeeded' | 'failed' | 'rolled-back' | 'rollback-failed' required
phase'queued' | 'plan' | 'backup' | 'verify' | 'apply' | 'health' | 'rollback' | 'complete' | 'admission' required
failure_codestring
requested_atstring date-time required

RFC 3339 UTC, microsecond precision.

started_atstring date-time

RFC 3339 UTC, microsecond precision.

finished_atstring date-time

RFC 3339 UTC, microsecond precision.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status