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

GetRemediationPolicy

Retrieve a remediation policy by its identifier

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • policyIdStringRequired

    UUID of the policy to retrieve

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the remediation policy

    Example: policy-001-abc

  • nameString

    Display name of the remediation policy

    Example: High CPU Auto-Restart

  • enabledBoolean

    Whether this policy is currently active

    Example: true

  • agentSelectorLinkedHashMap

    Label selector to match target agents

    Example: (nested object)

  • conditionOpString

    Logical operator combining multiple conditions (AND, OR)

    Example: AND

  • conditionsList

    Conditions for this resource

    Example: (nested array)

    • metricNameString

      Name of the metric to evaluate as a condition

      Example: cpu_usage_percent

    • operatorString

      Comparison operator (e.g. >, =, <=, ==)

      Example: >

    • thresholdLong

      Threshold value for the condition

      Example: 90

  • actionString

    Remediation action to execute when conditions are met

    Example: restart_service

  • actionParamsLinkedHashMap

    Parameters passed to the remediation action

    Example: (nested object)

  • cooldownSecInteger

    Cooldown period in seconds before this policy can trigger again

    Example: 300

  • verifyAfterSecInteger

    Delay in seconds after action execution before verifying success

    Example: 60

  • maxRetriesInteger

    Maximum number of retry attempts on failure

    Example: 3

  • createdAtString

    Created at

    Example: 2026-01-15T08:00:00Z

Endpoint

GET/api/v1/monitoring/remediation-policies/{policyId}

/api/v1/monitoring/remediation-policies/{policyId}

Operation ID

GetRemediationPolicy

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/remediation-policies/{policyId}' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "id": "policy-001-abc",
  "name": "High CPU Auto-Restart",
  "enabled": true,
  "agentSelector": null,
  "conditionOp": "AND",
  "conditions": [
    {}
  ],
  "action": "restart_service",
  "actionParams": null
}

Change History

This API has no change history records yet.

View all change history