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

TriggerRemediation

Immediately trigger a remediation policy execution for a specific agent

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 trigger

Body Fields

  • agentIdStringRequired

    UUID of the agent to apply the remediation to

    Example: agent-001-xyz

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of this execution record

    Example: exec-001-abc

  • policyIdString

    UUID of the policy that triggered this execution

    Example: policy-001-abc

  • agentIdString

    UUID of the agent targeted by this execution

    Example: agent-001-xyz

  • triggeredAtString

    Triggered at

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

  • actionString

    Remediation action that was executed

    Example: restart_service

  • statusString

    Current status of the execution (running, succeeded, failed)

    Example: succeeded

  • verifiedAtString

    Verified at

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

  • errorString

    Error message if the execution failed

    Example: connection refused

  • retryCountInteger

    Number of retry attempts made

    Example: 20

Endpoint

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

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

Operation ID

TriggerRemediation

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/remediation-policies/{policyId}/trigger' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"agentId":"agent-001-xyz"}'

Response Example

200
{
  "id": "exec-001-abc",
  "policyId": "policy-001-abc",
  "agentId": "agent-001-xyz",
  "triggeredAt": "example",
  "action": "restart_service",
  "status": "succeeded",
  "verifiedAt": "example",
  "error": "connection refused"
}

Change History

This API has no change history records yet.

View all change history