Create package policy
Headers
-
Kibana's anti Cross-Site Request Forgery token. Can be any string value.
Query parameters
-
format string
Simplified or legacy format for package inputs
Values are
simplified
orlegacy
.
Body
You should use inputs as an object and not use the deprecated inputs array.
-
description string
Package policy description
-
force boolean
Force package policy creation even if package is not verified, or if the agent policy is managed.
-
id string
Package policy unique identifier
-
inputs object
Package policy inputs (see integration documentation to know what inputs are available)
-
Package policy name (should be unique)
-
namespace string
The package policy namespace. Leave blank to inherit the agent policy's namespace.
-
output_id string | null
Output ID to send package data to
-
overrides object | null
Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.
-
Agent policy ID where that package policy will be added
-
policy_ids array[string]
Agent policy IDs where that package policy will be added
-
vars object
Package root level variable (see integration documentation for more information)
curl \
-X POST https://localhost:5601/api/fleet/package_policies \
-H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
-H "kbn-xsrf: string"
# Headers
kbn-xsrf: string
# Payload
{
"description": "my description",
"force": true,
"id": "string",
"inputs": {
"nginx-logfile": {
"enabled": true,
"streams": {
"nginx.access": {
"vars": {
"tags": [
"nginx-access"
],
"paths": [
"/var/log/nginx/access.log*"
],
"ignore_older": "72h",
"preserve_original_event": false
},
"enabled": true
}
}
}
},
"name": "nginx-123",
"namespace": "customnamespace",
"output_id": "output-id",
"overrides": {
"inputs": {}
},
"package": {
"name": "nginx",
"version": "1.6.0"
},
"policy_id": "agent-policy-id",
"policy_ids": [
"agent-policy-id"
],
"vars": {}
}
{
"item": {
"id": "string",
"inputs": [
{
"config": {},
"enabled": true,
"processors": [
"string"
],
"streams": [],
"type": "string",
"vars": {}
}
],
"revision": 42.0,
"description": "string",
"enabled": true,
"name": "string",
"namespace": "string",
"output_id": "string",
"overrides": {},
"package": {
"name": "string",
"requires_root": true,
"title": "string",
"version": "string"
},
"policy_id": "string",
"policy_ids": [
"string"
]
}
}
{
"error": "string",
"message": "string",
"statusCode": 42.0
}
{
"error": "string",
"message": "string",
"statusCode": 42.0
}