Get a package policy
https://{kibana_url}
- GET /api/fleet/package_policies/{packagePolicyId}
Get a package policy by ID.
Path Parameters
-
packagePolicyIdstringrequired -
The ID of the package policy
Responses
Successful response
-
item -
additional_datastreams_permissionsstring · max: 1000nullable -
Additional data stream permissions that will be added to the agent policy.
-
agentsnumber -
cloud_connector_idstringnullable -
ID of the cloud connector associated with this package policy.
-
cloud_connector_namestring · min: 1 · max: 255nullable -
Transient field for cloud connector name during creation.
-
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this integration to its inputs.
-
created_atstringrequired -
created_bystringrequired -
descriptionstring -
Package policy description
-
elasticsearchobject -
privilegesobject -
clusterstring · max: 100 -
enabledbooleanrequired -
The name of the custom field. Cannot contain spaces.
-
The value of the custom field.
-
idstringrequired -
Package policy unique identifier.
-
inputsanyOfrequired -
Package policy inputs.
-
compiled_inputobjectrequired -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this input.
-
configmap string to object -
Package variable (see integration documentation for more information)
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledbooleanrequired -
idstring -
keep_enabledboolean -
migrate_fromstring -
namestring -
policy_templatestring -
streamsobject · max: 1000required -
compiled_streamobjectrequired -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this stream.
-
configmap string to object -
Package variable (see integration documentation for more information)
-
data_streamobjectrequired -
datasetstringrequired -
elasticsearchobject -
dynamic_datasetboolean -
dynamic_namespaceboolean -
privilegesobject -
indicesstring · max: 100 -
typestring -
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledbooleanrequired -
idstring -
keep_enabledboolean -
migrate_fromstring -
release -
Values:
gabetaexperimental -
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
typestringrequired -
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
<string>object -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this input.
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledboolean -
Enable or disable that input. Defaults to
true(enabled). -
streamsmap string to object -
Input streams. Refer to the integration documentation to know which streams are available.
-
<string>object -
conditionstring · max: 10000nullable -
Agent condition expression to evaluate whether to apply this stream.
-
deprecated -
descriptionstring · max: 4096required -
replaced_bymap string to string -
sincestring · max: 50 -
enabledboolean -
Enable or disable that stream. Defaults to
true(enabled). -
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
-
varsmap string to anyOf -
Input/stream level variable. Refer to the integration documentation for more information.
-
is_managedboolean -
namestringrequired -
Unique name for the package policy.
-
namespacestring · max: 100 -
The package policy namespace. Leave blank to inherit the agent policy's namespace.
-
output_idstringnullable -
overridesobjectnullable -
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.
-
inputsmap string to object -
package -
experimental_data_stream_featuresobject · max: 100 -
data_streamstring · max: 1024required -
featuresobjectrequired -
doc_value_only_numericboolean -
doc_value_only_otherboolean -
synthetic_sourceboolean -
tsdbboolean -
fips_compatibleboolean -
namestring · max: 255required -
Package name
-
requires_rootboolean -
titlestring · max: 255 -
versionstring · max: 50required -
Package version
-
policy_idstringnullable deprecated -
ID of the agent policy which the package policy will be added to.
-
policy_idsstring · max: 1000 -
revisionnumberrequired -
Package policy revision.
-
secret_referencesobject · max: 1000 -
idstringrequired -
spaceIdsstring · max: 100 -
supports_agentlessbooleannullable -
Indicates whether the package policy belongs to an agentless agent policy.
-
supports_cloud_connectorbooleannullable -
Indicates whether the package policy supports cloud connectors.
-
updated_atstringrequired -
updated_bystringrequired -
var_group_selectionsmap string to string -
Variable group selections. Maps var_group name to the selected option name within that group.
-
varsanyOf -
Package level variable.
-
versionstring -
Package policy ES version.
object
Package policy inputs. Refer to the integration documentation to know which inputs are available.
Bad Request
-
attributesobjectrequired -
errorstring -
errorTypestring -
messagestringrequired -
statusCodenumber
Not Found
-
messagestringrequired