Install a package by upload

POST /api/fleet/epm/packages

Spaces method and path for this operation:

post /s/{space_id}/api/fleet/epm/packages

Refer to Spaces for more information.

Install a package by uploading a .zip or .tar.gz archive (max 100MB). Only available to superusers.

[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.

Headers

kbn-xsrf string Required

A required header to protect against CSRF attacks

Query parameters

ignoreMappingUpdateErrors boolean

When true, ignore mapping update errors during installation

Default value is false.
skipDataStreamRollover boolean

When true, skip data stream rollover after installation

Default value is false.

Body

string(binary)

Responses

200

application/gzip; application/zip

application/gzip; application/zip application/json

Successful response
Hide response attributes Show response attributes object
- _meta object Required
  
  Additional properties are NOT allowed.
  
  Hide _meta attributes Show _meta attributes object
  
  install_source string Required
  
  name string Required
- items array[object] Required
  
  Not more than 10000 elements.
  
  Any of:
  object-1 object object-2 object
  
  Hide attributes Show attributes
  
  deferred boolean
  
  id string Required
  
  originId string
  
  type string Required
  
  Any of:
  string-1 string string-2 string
  
  Values are dashboard, lens, visualization, search, index-pattern, map, ml-module, security-rule, csp-rule-template, osquery-pack-asset, osquery-saved-query, or tag.
  
  Hide attributes Show attributes
  
  deferred boolean
  
  id string Required
  
  type string Required
  
  Values are index, index_template, component_template, ingest_pipeline, ilm_policy, data_stream_ilm_policy, transform, ml_model, knowledge_base, or esql_view.
  
  version string
400

application/gzip; application/zip

application/gzip; application/zip application/json

Bad Request
Hide response attributes Show response attributes object
- attributes Required
- error string
- errorType string
- message string Required
- statusCode number

POST /api/fleet/epm/packages

curl \
 --request POST 'https://localhost:5601/api/fleet/epm/packages' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/gzip" \
 --header "kbn-xsrf: true"

curl \
 --request POST 'https://localhost:5601/api/fleet/epm/packages' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/gzip; application/zip" \
 --header "kbn-xsrf: true" \
 --data-binary '<binary package archive>'

Request example

Upload a .zip or .tar.gz package archive (max 100MB)

<binary package archive>

Request example

Upload a .zip or .tar.gz package archive (max 100MB)

<binary package archive>

Response examples (200)

Package successfully installed from upload

{"_meta" => {"install_source" => "upload"}, "items" => [{"id" => "my-custom-package-logs-default", "type" => "index_template"}]}

Response examples (200)

Package successfully installed from upload

{
  "_meta": {
    "install_source": "upload"
  },
  "items": [
    {
      "id": "my-custom-package-logs-default",
      "type": "index_template"
    }
  ]
}

Response examples (400)

Example of a generic error response

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

Response examples (400)

Example of a generic error response

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