POST /api/fleet/epm/packages
Api key auth

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

    Default value is false.

  • skipDataStreamRollover boolean

    Default value is false.

Body

Body

string(binary) string(binary)

Responses

  • 200

    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
  • 400

    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://<KIBANA_URL>/api/fleet/epm/packages' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/gzip" \
 --header "kbn-xsrf: true"
curl \
 --request POST 'https://<KIBANA_URL>/api/fleet/epm/packages' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/gzip; application/zip" \
 --header "kbn-xsrf: true" \
 --data-binary '@file'
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 (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}