Query parameters

• page number

  Default value is 0.

• perPage number

  Default value is 20.

• date string
• latest number
• errorSize number

  Default value is 5.

Responses

• 200 application/json

  OK: A successful request.

  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
    • hasRolloutPeriod boolean
    • is_automatic boolean
    • latestErrors array[object]

      latest errors that happened when the agents executed the action

      Hide latestErrors attributes Show latestErrors attributes object

      • agentId string Required
      • error string Required
      • hostname string
      • timestamp string Required
    • 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 number

      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 UPGRADE, UNENROLL, SETTINGS, POLICY_REASSIGN, CANCEL, FORCE_UNENROLL, REQUEST_DIAGNOSTICS, UPDATE_TAGS, POLICY_CHANGE, INPUT_ACTION, MIGRATE, or PRIVILEGE_LEVEL_CHANGE.

    • version string

      agent version number (UPGRADE action)

• 400 application/json

  A bad request.

  Hide response attributes Show response attributes object

  • error string
  • errorType string
  • message string Required
  • statusCode number