Update package settings

Base URL
https://{kibana_url}
Auth

Update settings for a specific version of a package.

Required authorization

Privileges integrations-all and fleet-agent-policies-all

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.

pkgName string required

Package name

pkgVersion string optional

Package version

Leave it out to use /api/fleet/epm/packages/{pkgName}.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

keepPoliciesUpToDate boolean
namespace_customization_enabled_for string[] · max items: 100

Namespaces for which namespace-level customization is enabled on this package.

namespace_customization_settings map string to object

Per-namespace managed settings (for example, ILM policy) for this package. Keyed by namespace name.

<string> object
ilm_policy string · min length: 1 · max length: 1024

Responses

Successful response

application/json
item object required
agent object
privileges object
root boolean
asset_tags object[] · max items: 1000
asset_ids string[] · max items: 1000
asset_types string[] · max items: 100
text string required
assets map string to object required
categories string[] · max items: 100
conditions object
deprecated object
description string · max length: 4096 required
replaced_by map string to string
<string> string · max length: 1024
since string · max length: 50
elastic object
capabilities string[] · max items: 10
subscription string
kibana object
version string
data_streams string to object[] · max items: 1000
deprecated object
description string · max length: 4096 required
replaced_by map string to string
<string> string · max length: 1024
since string · max length: 50
description string
discovery object
datasets object[] · max items: 100
name string required
fields object[] · max items: 100
name string required
download string
elasticsearch map string to object
format_version string
icons object[] · max items: 100
dark_mode boolean
path string
size string
src string required
title string
type string
installationInfo object
additional_spaces_installed_kibana map string to object
<string> object[] · max items: 100
created_at string
experimental_data_stream_features object[] · max items: 100
data_stream string · max length: 1024 required
features object required
doc_value_only_numeric boolean
doc_value_only_other boolean
synthetic_source boolean
tsdb boolean
install_format_schema_version string
install_source enum required
Values: registry upload bundled custom
install_status enum required
Values: installed installing install_failed
installed_es object[] · max items: 10000 required
customDataStreamOriginDataset string
customDataStreamOriginType string
deferred boolean
id string required
type enum required
Values: index index_template component_template ingest_pipeline ilm_policy data_stream_ilm_policy transform ml_model knowledge_base esql_view
version string
installed_kibana object[] · max items: 10000 required
deferred boolean
id string required
originId string
type union enum | string required
Values: dashboard lens visualization search index-pattern map ml-module security-rule csp-rule-template osquery-pack-asset osquery-saved-query tag
installed_kibana_space_id string
is_rollback_ttl_expired boolean
latest_executed_state object
error string
name string
started_at string
latest_install_failed_attempts object[] · max items: 10
created_at string required
error object required
message string required
name string required
stack string
missing_assets object[] · max items: 10000
id string required
type string required
target_version string required
name string required
namespaces string[] · max items: 100
previous_version string nullable
rolled_back boolean
type string required
updated_at string
verification_key_id string nullable
verification_status enum required
Values: unverified verified unknown
version string required
internal boolean
keepPoliciesUpToDate boolean
latestVersion string
license string
licensePath string
name string required
notice string
owner object
github string
type enum
Values: elastic partner community
path string
policy_templates string to object[] · max items: 1000
readme string
release enum
Values: ga beta experimental
screenshots object[] · max items: 100
dark_mode boolean
path string
size string
src string required
title string
type string
signature_path string
source object
license string required
status string
title string required
type union enum | string
Values: integration input content
var_groups object[] · max items: 100
description string
name string required
options object[] · max items: 100 required
description string
hide_in_deployment_modes enum[] · max items: 2
Values: default agentless
name string required
title string required
vars string[] · max items: 100 required
selector_title string required
title string required
vars string to object[] · max items: 1000
version string required
warnings object[] · max items: 100
baseTemplateName string · max length: 1000 required
conflictingTemplates object[] · max items: 100 required
conflictType enum required
Values: overrides_fleet blocked_by_same_priority overridden_by_fleet
name string · max length: 1000 required
priority number required
dataStreamName string · max length: 1000 required
namespace string · max length: 255 required
nsTemplateName string · max length: 1000 required

Bad Request

application/json
attributes object required
error string
errorType string
message string required
statusCode number
Base URL
https://{kibana_url}