Install a package from the registry

POST /api/fleet/epm/packages/{pkgName}/{pkgVersion}
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

[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

Path parameters

  • pkgName string Required
  • pkgVersion string

Query parameters

  • prerelease boolean
  • ignoreMappingUpdateErrors boolean

    Default value is false.

  • skipDataStreamRollover boolean

    Default value is false.

application/json

Body

  • force boolean

    Default value is false.

  • ignore_constraints boolean

    Default value is false.

Responses

  • 200 application/json
    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
      Any of:
      object-1 object object-2 object
  • 400 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/epm/packages/{pkgName}/{pkgVersion} 
curl \
 --request POST 'https://localhost:5601/api/fleet/epm/packages/{pkgName}/{pkgVersion}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"force":false,"ignore_constraints":false}'