Query parameters

• perPage integer

  The number of items to return

  Default value is 20.

• page integer

  Default value is 1.

• errorSize integer

  Default value is 5.

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • items array[object] Required
    Hide items attributes Show items attributes object

    • actionId string Required
    • cancellationTime string
    • completionTime string
    • creationTime string Required

      creation time of action

    • expiration string
    • latestErrors array[object]

      latest errors that happened when the agents executed the action

      Hide latestErrors attributes Show latestErrors attributes object

      • agentId string
      • error string
      • timestamp string
    • nbAgentsAck number Required

      number of agents that acknowledged the action

    • nbAgentsActionCreated number Required

      number of agents included in action from kibana

    • nbAgentsActioned number Required

      number of agents actioned

    • nbAgentsFailed number Required

      number of agents that failed to execute the action

    • newPolicyId string

      new policy id (POLICY_REASSIGN action)

    • policyId string

      policy id (POLICY_CHANGE action)

    • revision string

      new policy revision (POLICY_CHANGE action)

    • startTime string

      start time of action (scheduled actions)

    • status string Required

      Values are COMPLETE, EXPIRED, CANCELLED, FAILED, IN_PROGRESS, or ROLLOUT_PASSED.

    • type string Required

      Values are POLICY_REASSIGN, UPGRADE, UNENROLL, FORCE_UNENROLL, UPDATE_TAGS, CANCEL, REQUEST_DIAGNOSTICS, SETTINGS, POLICY_CHANGE, or INPUT_ACTION.

    • version string

      agent version number (UPGRADE action)

• 400 application/json

  Generic Error

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode number