Create an agent policy

Server: https://{kibana_url}

POST /api/fleet/agent_policies

Api key auth Basic auth

Create a new agent policy.

[Required authorization] Route required privileges: fleet-agent-policies-all.

Query Parameters

sys_monitoring boolean: Whether to add the system integration to the new agent policy

Request

Responses

Successful response

application/json

Bad Request

application/json

Examples

Create a new agent policy

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/fleet/agent_policies
{
  "description": "A sample agent policy",
  "monitoring_enabled": [
    "logs",
    "metrics"
  ],
  "name": "My agent policy",
  "namespace": "default"
}

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/agent_policies" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "A sample agent policy",
  "monitoring_enabled": [
    "logs",
    "metrics"
  ],
  "name": "My agent policy",
  "namespace": "default"
}'

Response

{
  "item": {
    "description": "A sample agent policy",
    "id": "agent-policy-id-2",
    "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
}