Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-04193459793.6 KB
RemediationService

Cancels a pending remediation.

Only remediations in PENDING_APPROVAL or PENDING state can be cancelled.

post/compute/clusters/{cluster_id}/instances/{instance_id}/remediations/{remediation_id}/cancel

Path parameters

cluster_idstring required

The cluster ID.

instance_idstring required

The instance ID.

remediation_idstring required

The remediation ID.

Response

OK

idstring required
cluster_idstring required
instance_idstring required
mode'REMEDIATION_MODE_VM_ONLY' | 'REMEDIATION_MODE_HOST_AWARE' | 'REMEDIATION_MODE_EVICT_WITHOUT_REPLACEMENT' | 'REMEDIATION_MODE_REBOOT_VM' | 'REMEDIATION_MODE_HOST_POWER_CYCLE' required

Remediation mode specifies how the remediation should be performed.

  • REMEDIATION_MODE_VM_ONLY: Deletes the VM and provisions a new one on any available host.
  • REMEDIATION_MODE_HOST_AWARE: Cordons the host, deletes the VM, and provisions a new one on a different host.
  • REMEDIATION_MODE_EVICT_WITHOUT_REPLACEMENT: Evicts the VM without provisioning a replacement.
  • REMEDIATION_MODE_REBOOT_VM: Reboots the VM in place.
  • REMEDIATION_MODE_HOST_POWER_CYCLE: Cordons and power-cycles the bare-metal host while preserving host and node identity.
trigger'REMEDIATION_TRIGGER_MANUAL' | 'REMEDIATION_TRIGGER_AUTOMATED' required

RemediationTrigger specifies how the remediation was triggered.

  • REMEDIATION_TRIGGER_MANUAL: A user-initiated remediation (either via web UI or API call).
  • REMEDIATION_TRIGGER_AUTOMATED: A system-initiated remediation that requires approval.
state'PENDING_APPROVAL' | 'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' | 'AUTO_RESOLVED' | 'QUARANTINING' | 'QUARANTINED' required

RemediationState represents the lifecycle state of a remediation.

  • PENDING_APPROVAL: Awaiting approval before processing can begin.
  • PENDING: Approved and queued for processing.
  • RUNNING: Actively being processed.
  • SUCCEEDED: Successfully completed.
  • FAILED: Failed with an error.
  • CANCELLED: Cancelled by user or system.
  • AUTO_RESOLVED: The underlying issue was automatically resolved before processing.
  • QUARANTINING: Cordoning or preparing the host before remediation.
  • QUARANTINED: Host has been cordoned or isolated for remediation.
reasonstring

User-provided reason for the remediation.

active_health_check_run_idstring

Active health check run ID (UUID) that triggered this remediation.

passive_health_check_event_idstring

Passive health check event ID that triggered this remediation.

requested_bystring

Who requested the remediation.

create_timestring date-time

When the remediation was created.

reviewed_bystring

Who reviewed the remediation.

review_timestring date-time

When the remediation was reviewed.

review_commentstring

Review comment.

start_timestring date-time

When processing started.

end_timestring date-time

When the remediation completed.

error_messagestring

Error message if the remediation failed.

update_timestring date-time

When the remediation was last updated.

instance_namestring

Display name of the targeted instance.