Install a package from the registry

Base URL: https://{kibana_url}

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

Auth

Install a specific version of a package from the Elastic Package Registry.

Required privileges

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

Path parameters

pkgName string required

Package name

pkgVersion string optional

Package version

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

Query parameters

prerelease boolean: When true, allow installing prerelease versions
ignoreMappingUpdateErrors boolean · default: false: When true, ignore mapping update errors during installation
skipDataStreamRollover boolean · default: false: When true, skip data stream rollover after installation
skipDependencyCheck boolean · default: false: Skip dependency validation when installing a package with dependencies

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

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
ignore_constraints boolean · default: false

Responses

Successful response

application/json

_meta object required
items union anyOf[] · max items: 10000 required: Any of:

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Install a package, optionally ignoring constraints

Console Kibana Dev Tools

POST kbn:/api/fleet/epm/packages/PKG_NAME/PKG_VERSION
{
  "ignore_constraints": false
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/epm/packages/${PKG_NAME}/${PKG_VERSION}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "ignore_constraints": false
  }'

Generated from the API spec

Response

Package successfully installed

{
  "_meta": {
    "install_source": "registry"
  },
  "items": [
    {
      "id": "aws-logs-aws.cloudwatch_logs-default",
      "type": "index_template"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}