Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Auto Remediation
GETMonitoringSince 1.0SynchronousAuth Required

PreviewRemediationAction

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • actionIdStringRequired

    UUID of the action to preview

Responses

200 OK

On success, this API returns the following response structure.

  • actionIdString

    ID of the action being previewed

    Example: action-001-abc

  • affectedVmsInteger

    Number of VMs that would be affected by this action

    Example: 4

  • expectedDowntimeString

    Expected downtime duration for affected VMs

    Example: 30s

  • rollbackPlanString

    Description of the rollback plan if the action fails

    Example: Revert VM placements to original host if migration fails

  • stepsList

    Steps for this resource

    Example: item1,item2

Endpoint

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

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

Operation ID

PreviewRemediationAction

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/remediation/actions/{actionId}/preview' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "actionId": "action-001-abc",
  "affectedVms": 4,
  "expectedDowntime": "30s",
  "rollbackPlan": "Revert VM placements to original host if migration fails",
  "steps": []
}

Change History

This API has no change history records yet.

View all change history