Update package policy by ID

Base URL
https://{kibana_url}
Auth

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.

packagePolicyId string required

Query parameters

format enum

Simplified or legacy format for package inputs

Values: simplified legacy

Header parameters

kbn-xsrf string required

Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Request body

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 map string to object

Package policy inputs (see integration documentation to know what inputs are available)

<string> object
enabled boolean

enable or disable that input, (default to true)

streams map string to object

Input streams (see integration documentation to know what streams are available)

<string> object
enabled boolean

enable or disable that stream, (default to true)

vars object

Stream level variable (see integration documentation for more information)

vars object

Input level variable (see integration documentation for more information)

name string required

Package policy name (should be unique)

namespace string

The package policy namespace. Leave blank to inherit the agent policy's namespace.

output_id string nullable

Output ID to send package data to

overrides object nullable

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.

inputs object
package object required
name string required

Package name

version string required

Package version

policy_id string nullable deprecated

Agent policy ID where that package policy will be added

policy_ids string[]

Agent policy IDs where that package policy will be added

vars object

Package root level variable (see integration documentation for more information)

Responses

OK

application/json
item object required
id string required
inputs union oneOf required
One of: object[] or object
revision number required
description string
enabled boolean
name string required
namespace string
output_id string
overrides object
package object
name string required
requires_root boolean
title string
version string required
policy_id string nullable deprecated
policy_ids string[]

Generic Error

application/json
error string
message string
statusCode number
Base URL
https://{kibana_url}