Get agents by action ids

Server: https://{kibana_url}

POST /api/fleet/agents

Retrieve agents associated with specific action IDs.

[Required authorization] Route required privileges: fleet-agents-read.

Request

actionIds [] string · max: 1000 required

Responses

Successful response

application/json

Bad Request

application/json

Examples

Retrieve agents associated with specific action IDs

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/agents
{
  "actionIds": [
    "action-id-1",
    "action-id-2"
  ]
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/agents" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "actionIds": [
    "action-id-1",
    "action-id-2"
  ]
}'

Response

{
  "items": [
    {
      "active": true,
      "id": "agent-id-1",
      "policy_id": "agent-policy-id-1",
      "status": "online"
    }
  ],
  "total": 1
}

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