Bulk install packages
Base URL
https://{kibana_url}
POST
/api/fleet/epm/packages/_bulk
POST
/s/{space_id} /api/fleet/epm/packages/_bulk
Auth
Install multiple packages from the Elastic Package Registry in a single request.
Privileges
integrations-all
and
fleet-agent-policies-all
Expand all
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.
prerelease
boolean
When true, allow installing prerelease versions
A required header to protect against CSRF attacks
{
}
acknowledge_breaking_changes
boolean · default: false
When true, acknowledge the breaking changes listed in the package changelog for the versions being upgraded. Without it, an upgrade whose version range includes breaking changes is rejected. The force flag does not bypass this check.
allow_outdated_version
boolean · default: false
When true, allow installing a version older than the latest available. Bypasses only the out-of-date version check.
force
boolean · default: false
packages
union anyOf [] · min items: 1 · max items: 1000 required
Any of:
string
{ name, version, prerelease }
−
Hide 3 properties
name
string · min length: 0 required
items
union anyOf [] · max items: 10000 required
Any of:
−
Hide 3 properties
result
object required
−
Hide 5 properties
assets
union anyOf [] · max items: 10000
Any of:
−
Hide 4 properties
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
−
Hide 6 properties
customDataStreamOriginDataset
string
customDataStreamOriginType
string
type
enum required
Values:
index
index_template
component_template
ingest_pipeline
ilm_policy
data_stream_ilm_policy
transform
ml_model
knowledge_base
esql_view
installType
string required
status
enum
Values:
installed
already_installed
−
Hide 3 properties
error
union anyOf
Any of:
string
or
object
statusCode
number required
attributes
object required
Thank you for your feedback.
Base URL
https://{kibana_url}
Examples
Request
Console
1 / 2 languages
‹
›
Install multiple packages from the registry
Show more
1
2
3
4
5
6
7
POST kbn:/api/fleet/epm/packages/_bulk
{
"packages": [
"system",
"aws"
]
}
Generated from the API spec
1
2
3
4
5
6
7
8
9
10
curl -X POST "${KIBANA_URL}/api/fleet/epm/packages/_bulk" \
-H "kbn-xsrf: true" \
-H "Authorization: ApiKey ${API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"packages": [
"system",
"aws"
]
}'
Generated from the API spec
Response
Example of a generic error response
Show more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"items": [
{
"name": "system",
"result": {
"assets": [],
"status": "installed"
}
},
{
"name": "aws",
"result": {
"assets": [],
"status": "installed"
}
}
]
}
1
2
3
4
5
{
"error": "Bad Request",
"message": "An error message describing what went wrong",
"statusCode": 400
}