Update package settings

Base URL: https://{kibana_url}

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

Auth

Update settings for a specific version of a package.

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}.

Header parameters

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

Request body

keepPoliciesUpToDate boolean
namespace_customization_enabled_for string[] · max items: 100: Namespaces for which namespace-level customization is enabled on this package.
namespace_customization_settings map string to object: Per-namespace managed settings (for example, ILM policy) for this package. Keyed by namespace name.

Responses

Successful response

application/json

item object required
warnings object[] · max items: 100

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Enable namespace-level customization for the production and staging namespaces

Console Kibana Dev Tools

PUT kbn:/api/fleet/epm/packages/PKG_NAME/PKG_VERSION
{
  "namespace_customization_enabled_for": [
    "production",
    "staging"
  ]
}

Generated from the API spec

curl Shell

curl -X PUT "${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 '{
    "namespace_customization_enabled_for": [
      "production",
      "staging"
    ]
  }'

Generated from the API spec

Response

Updated package settings

{
  "item": {
    "keepPoliciesUpToDate": true,
    "name": "aws",
    "version": "2.10.0"
  }
}

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

Request Console 1 / 2 languages

Update keep_policies_up_to_date setting for a package

Console Kibana Dev Tools

PUT kbn:/api/fleet/epm/packages/PKG_NAME
{
  "keepPoliciesUpToDate": true
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Updated package settings

{
  "item": {
    "keepPoliciesUpToDate": true,
    "name": "aws",
    "version": "2.10.0"
  }
}

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