Install package

POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}

Headers

kbn-xsrf string Required

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

Path parameters

pkgName string Required
pkgVersion string Required

Query parameters

ignoreMappingUpdateErrors boolean

avoid erroring out on unexpected mapping update errors

Default value is false.
skipDataStreamRollover boolean

Skip data stream rollover during index template mapping or settings update

Default value is false.
ignoreUnverified boolean

Ignore if the package is fails signature verification
full boolean

Return all fields from the package manifest, not just those supported by the Elastic Package Registry
prerelease boolean

Whether to return prerelease versions of packages (e.g. beta, rc, preview)

Default value is false.

application/json; Elastic-Api-Version=2023-10-31

Body

force boolean
ignore_constraints boolean

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attributes Show response attributes object
- _meta object
  
  Hide _meta attribute Show _meta attribute object
  
  install_source string
  
  Values are registry, upload, or bundled.
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  id string Required
  
  type string Required
  
  One of:
  Fleet_kibana_saved_object_type string Fleet_elasticsearch_asset_type string
  
  Values are dashboard, visualization, search, index-pattern, map, lens, ml-module, security-rule, or csp_rule_template.
  
  Values are component_template, ingest_pipeline, index_template, ilm_policy, transform, or data_stream_ilm_policy.
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}

curl \
 -X POST http://localhost:5601/api/fleet/epm/packages/{pkgName}/{pkgVersion} \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"

Request examples

# Headers
kbn-xsrf: string

# Payload
{
  "force": true,
  "ignore_constraints": true
}

Response examples (200)

{
  "_meta": {
    "install_source": "registry"
  },
  "items": [
    {
      "id": "string",
      "type": "dashboard"
    }
  ]
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}