Skip to main content
Monitoring & Collection/Auto Remediation

TriggerRemediation

Immediately trigger a remediation policy execution for a specific agent

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

Operation ID

TriggerRemediation

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

application/json

Path Parameters

  • policyId
    StringRequired

    UUID of the policy to trigger

Body Fields

  • agentId
    StringRequired

    UUID of the agent to apply the remediation to

    Example: agent-001-xyz

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of this execution record

    Example: exec-001-abc

  • policyId
    String

    UUID of the policy that triggered this execution

    Example: policy-001-abc

  • agentId
    String

    UUID of the agent targeted by this execution

    Example: agent-001-xyz

  • triggeredAt
    String

    Triggered at

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

  • action
    String

    Remediation action that was executed

    Example: restart_service

  • status
    String

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

    Example: succeeded

  • verifiedAt
    String

    Verified at

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

  • error
    String

    Error message if the execution failed

    Example: connection refused

  • retryCount
    Integer

    Number of retry attempts made

    Example: 20