Create an agent policy

Base URL: https://{kibana_url}

POST /api/fleet/agent_policies

Create a new agent policy.

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

advanced_settings object
agent_features object[] · max items: 100
agentless object
data_output_id string nullable
description string
download_source_id string nullable deprecated: Use download_source_ids instead
download_source_ids string[] · max items: 3
fleet_server_host_id string nullable
force boolean
global_data_tags object[] · max items: 100: User defined data tags that are added to all of the inputs. The values can be strings or numbers.
has_agent_version_conditions boolean
has_fleet_server boolean
id string
inactivity_timeout number · min: 0 · default: 1209600
is_default boolean
is_default_fleet_server boolean
is_managed boolean
is_protected boolean
is_verifier boolean
keep_monitoring_alive boolean nullable: When set to true, monitoring will be enabled but logs/metrics collection will be disabled
min_agent_version string nullable
monitoring_diagnostics object
monitoring_enabled enum[] · max items: 3: Values: logs metrics traces
monitoring_http object
monitoring_output_id string nullable
monitoring_pprof_enabled boolean
name string · min length: 1 required
namespace string · min length: 1 required
overrides map string to object nullable: Override settings that are defined in the agent policy. Input settings cannot be overridden. The override option should be used only in unusual circumstances and not as a routine procedure.
package_agent_version_conditions object[] · max items: 1000 nullable
required_versions object[] · max items: 100 nullable
space_ids string[] · max items: 100
supports_agentless boolean nullable deprecated: Indicates whether the agent policy supports agentless integrations. Deprecated in favor of the Fleet managed integrations API.
unenroll_timeout number · min: 0

Responses

Successful response

application/json

item object required

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create a new agent policy

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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