BRbrumby
bundles

Create Bundle Deployment

Re-plan from fresh evidence, confirm the previewed intent, reserve the N100 and record the requested event. The same key and body return the same deployment.

post/api/v1/devices/{device_id}/bundle-deployments

Request

  • Base URL
    https://api.brumby.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.brumby.com/api/v1/devices/{device_id}/bundle-deployments
  • Auth
    HTTP bearer

Path parameters

device_idstring required

Headers

Idempotency-Keystring nullable

Request body

kind'onboard' | 'upgrade' | 'rollback' | 'repair' required
target_bundle_release_idstring uuid required
transition_idstring uuid nullable
checkpointstring nullable
plan_intent_sha256string required

Response

Successful Response

deployment_idstring uuid required
device_idstring required
companion_idstring required
binding_generationinteger required
profilestring required
kind'onboard' | 'upgrade' | 'rollback' | 'repair' required
source_bundle_release_idstring uuid nullable required
target_bundle_release_idstring uuid required
transition_idstring uuid nullable required
transition_sha256string nullable required
checkpointstring nullable required
previous_deployment_idstring uuid nullable required
phase'queued' | 'preflight' | 'staging' | 'entering_maintenance' | 'applying' | 'verifying' | 'exiting_maintenance' | 'complete' | 'blocked' | 'recovering' | 'failed' | 'cancelled' | 'expired' | 'recovery_required' required
reason_detailunknown
reached_checkpointstring nullable required
maintenance_activeboolean required
local_target_verifiedboolean required
plan_sha256string required
plan_intent_sha256string required
inventory_sha256string required
inventory_source'onboarding_probe' | 'device_reports' required
admission_deadlinestring date-time required
cancel_requested_atstring date-time nullable required
cancel_requested_bystring nullable required
created_bystring required
created_atstring date-time required
updated_atstring date-time required
finished_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.