Skip to main content
ZStack
Monitoring & Collection/Auto Remediation

PreviewRemediationAction

Preview the expected impact and execution steps of a remediation action before running it

GET/api/v1/monitoring/remediation/actions/{actionId}/preview

Operation ID

PreviewRemediationAction

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • actionId
    StringRequired

    UUID of the action to preview

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • actionId
    String

    ID of the action being previewed

    Example: action-001-abc

  • affectedVms
    Integer

    Number of VMs that would be affected by this action

    Example: 4

  • expectedDowntime
    String

    Expected downtime duration for affected VMs

    Example: 30s

  • rollbackPlan
    String

    Description of the rollback plan if the action fails

    Example: Revert VM placements to original host if migration fails

  • steps
    List

    Steps for this resource

    Example: item1,item2