Trigger an agent run

This API allows to trigger an agent run on the target node. Response is a stream of the actual agent run on the node.

post/nodes/{nodeId}/applyPolicy

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/nodes/:nodeId/applyPolicy/post.ts
A function with typed inputs. Its response is checked against the schema.

nodeIdstring uuid (or "root") required

Example:9a1773c9-0889-40b6-be89-f6504443ac1b

Id of the target node

classesstring[]

Parameter to trigger a specific run, like an inventory for instance.

{
  "classes": [
    "force_inventory"
  ]
}

Agent output