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

GenerateRemediationActions

Generate candidate remediation actions for a given resource failure scenario

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • resourceTypeStringRequired

    Type of the failing resource

    Example: host

  • resourceIdStringRequired

    UUID of the failing resource

    Example: host-001-xyz

  • resourceNameStringRequired

    Display name of the failing resource

    Example: compute-node-01

  • failureTypeStringRequired

    Type of failure to remediate

    Example: hardware_failure

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of the remediation action

      Example: action-001-abc

    • typeString

      Type of the remediation action (e.g. migrate_vm, restart_service)

      Example: migrate_vm

    • descriptionString

      Human-readable description of what this action does

      Example: Migrate all VMs from the failing host to available standby hosts

    • estimatedDurationString

      Estimated time to complete this action

      Example: 5m

    • riskLevelString

      Risk level of executing this action (low, medium, high)

      Example: medium

    • preconditionsList

      Preconditions for this resource

      Example: item1,item2

    • targetResourcesList

      Target resources

      Example: (nested array)

      • typeString

        Resource type of the migration target (e.g. host)

        Example: host

      • idString

        UUID of the target resource

        Example: host-002-backup

      • nameString

        Display name of the target resource

        Example: standby-node-01

      • capacityString

        Available capacity description on the target resource

        Example: 80%

      • canMigrateVmsInteger

        Number of VMs that can be migrated to this target (1 = yes, 0 = no)

        Example: 1

    • scoreLong

      Confidence score for this action recommendation (0.0 – 1.0)

      Example: 0.92

Endpoint

POST/api/v1/monitoring/remediation/actions

/api/v1/monitoring/remediation/actions

Operation ID

GenerateRemediationActions

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/remediation/actions' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"resourceType":"host","resourceId":"host-001-xyz","resourceName":"compute-node-01","failureType":"hardware_failure"}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history