Get an agent action status

Base URL: https://{kibana_url}

GET /api/fleet/agents/action_status

Auth

Get the current status of recent agent actions.

Required privileges

Privileges fleet-agents-read

Query parameters

page number · default: 0: Page number
perPage number · default: 20: Number of results per page
date string: Return actions created before this date
latest number: Return only the latest N actions
scheduledOnly boolean: Return only actions whose start_time is in the future
errorSize number · default: 5: Number of error details to include per action

Responses

Successful response

application/json

items object[] · max items: 10000 required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agents/action_status

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/agents/action_status" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Status of recent agent actions

{
  "items": [
    {
      "actionId": "action-id-1",
      "completionTime": "2024-01-01T00:05:00.000Z",
      "creationTime": "2024-01-01T00:00:00.000Z",
      "nbAgentsAck": 2,
      "nbAgentsActioned": 2,
      "nbAgentsFailed": 0,
      "status": "COMPLETE",
      "type": "UPGRADE"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}