Get agents by action ids

Base URL: https://{kibana_url}

POST /api/fleet/agents
POST /s/{space_id}/api/fleet/agents

Auth

Retrieve agents associated with specific action IDs.

Required authorization

Privileges fleet-agents-read

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

actionIds string[] · max items: 1000 required

Responses

Successful response

application/json

items string[] · max items: 10000 required

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Retrieve agents associated with specific action IDs

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Agents associated with the given actions

{
  "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
}

Required authorization

Path parameters

Header parameters

Request body { }

Responses

Request body