Bulk get agent policies

Base URL: https://{kibana_url}

POST /api/fleet/agent_policies/_bulk_get

Get multiple agent policies by ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Header parameters

Request body

Responses

Successful response

application/json

items object[] · max items: 10000 required

Bad Request

application/json

404

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Retrieve multiple agent policies by ID

Console Kibana Dev Tools

POST kbn:/api/fleet/agent_policies/_bulk_get
{
  "ids": [
    "agent-policy-id-1",
    "agent-policy-id-2"
  ]
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

The requested agent policies

{
  "items": [
    {
      "id": "agent-policy-id-1",
      "is_managed": false,
      "is_protected": false,
      "name": "My agent policy",
      "namespace": "default",
      "revision": 1,
      "status": "active",
      "updated_at": "2024-01-15T10:00:00.000Z",
      "updated_by": "user1"
    }
  ]
}

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

{
  "error": "Not Found",
  "message": "An error message describing what went wrong",
  "statusCode": 404
}

Required authorization

Authentication

Query parameters

Header parameters

Request body { }

Responses

Request body