Sign in
Elastic Package Manager (EPM)

Install a package from the registry

Spaces method and path for this operation:

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/fleet/epm/packages/{pkgName}</span></div>

Refer to Spaces for more information.

Install the latest version of a package from the Elastic Package Registry.<br/><br/>[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.

post/api/fleet/epm/packages/{pkgName}

Path parameters

pkgNamestring required

Package name

Query parameters

prereleaseboolean

When true, allow installing prerelease versions

ignoreMappingUpdateErrorsboolean

When true, ignore mapping update errors during installation

skipDataStreamRolloverboolean

When true, skip data stream rollover after installation

skipDependencyCheckboolean

Skip dependency validation when installing a package with dependencies

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

allow_outdated_versionboolean

When true, allow installing a version older than the latest available. Bypasses only the out-of-date version check.

forceboolean
ignore_constraintsboolean

Response

Successful response

Changes

Changed in 2 of the 92 revisions of this API.11

  • deb2e8b751e71See the full diff
    • ●

      for the path request parameter pkgName, the maxLength was set to 255

      request-parameter-max-length-set

  • b8f471c6e5a41See the full diff
    • ○

      added the new optional request property allOf[subschema #1: install_package_from_registry_request]/allow_outdated_version

      new-optional-request-property