Deployment Rings
Phased rollout scheduling for update deployments
📄️ Get available phase presets
Returns all available rollout phase presets (conservative, moderate, aggressive, immediate).
📄️ Get IANA timezones and server timezone
Returns list of IANA timezones and the server's current timezone.
📄️ Get rollout status for all rings
Returns rollout status, phase progression, execution statistics, and next deployment window for all rings.
📄️ Get deployment windows for calendar view
Returns deployment window events for a date range, grouped by date. Includes execution history and skip status.
📄️ Skip a deployment window
Adds a date to the ring's exclusion dates, preventing deployment on that day.
📄️ Restore a skipped deployment window
Removes a previously skipped date from exclusion dates.
📄️ Create a new deployment ring
Creates a deployment ring with rollout phases, deployment windows, emergency controls, and auto-reboot settings. Maximum 25 per tenant.
📄️ List all deployment rings
Returns all deployment rings for the tenant with assigned policies and schedule summaries.
📄️ Create deployment ring from preset
Creates a deployment ring using a predefined phase preset (conservative, moderate, aggressive, immediate).
📄️ Import deployment ring from JSON
Creates a deployment ring from an exported JSON definition. Imported rings start as inactive.
📄️ Get a single deployment ring
Returns a deployment ring with assigned policies and schedule/phase summaries.
📄️ Update a deployment ring
Updates fields on a deployment ring. Phase percentages must be increasing and final phase must be 100%.
📄️ Delete a deployment ring
Deletes a deployment ring.
📄️ Duplicate a deployment ring
Creates a copy of an existing deployment ring with a new name.
📄️ Reset ring phases to a preset
Replaces the ring's rollout phases with a preset configuration.
📄️ Get policies assigned to a deployment ring
Returns all policies associated with a deployment ring.
📄️ List deployment executions with filters
Returns paginated deployment executions with optional filters by ring, status, phase, and agent.
📄️ Get deployment execution statistics
Returns aggregate statistics for deployment executions over a time range.
📄️ Get a specific deployment execution
Returns details of a single deployment execution.
📄️ Cancel a deployment execution
Cancels a pending or in-progress deployment execution.
📄️ Trigger reboot for a deployment execution
Sends a reboot command to the agent associated with a deployment execution.