Update package settings

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

[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
application/json

Body

  • keepPoliciesUpToDate boolean Required

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are allowed.

      Hide item attributes Show item attributes object
      • agent object

        Additional properties are NOT allowed.

        Hide agent attribute Show agent attribute object
        • privileges object

          Additional properties are NOT allowed.

          Hide privileges attribute Show privileges attribute object
          • root boolean
      • asset_tags array[object]
        Hide asset_tags attributes Show asset_tags attributes object
        • asset_ids array[string]
        • asset_types array[string]
        • text string Required
      • assets object Required

        Additional properties are allowed.

      • categories array[string]
      • conditions object

        Additional properties are allowed.

        Hide conditions attributes Show conditions attributes object
        • elastic object

          Additional properties are allowed.

          Hide elastic attributes Show elastic attributes object
          • capabilities array[string]
          • subscription string
        • kibana object

          Additional properties are allowed.

          Hide kibana attribute Show kibana attribute object
          • version string
      • data_streams array[object]

        Additional properties are allowed.

      • description string
      • discovery object

        Additional properties are allowed.

        Hide discovery attribute Show discovery attribute object
        • fields array[object]
          Hide fields attribute Show fields attribute object
          • name string Required
      • download string
      • elasticsearch object

        Additional properties are allowed.

      • format_version string
      • icons array[object]
        Hide icons attributes Show icons attributes object
        • dark_mode boolean
        • path string
        • size string
        • src string Required
        • title string
        • type string
      • installationInfo object

        Additional properties are allowed.

        Hide installationInfo attributes Show installationInfo attributes object
        • additional_spaces_installed_kibana object
          Hide additional_spaces_installed_kibana attribute Show additional_spaces_installed_kibana attribute object
          • * array[object] Additional properties
            Hide * attributes Show * attributes object
            • 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.

        • created_at string
        • experimental_data_stream_features array[object]
          Hide experimental_data_stream_features attributes Show experimental_data_stream_features attributes object
          • data_stream string Required
          • features object Required

            Additional properties are allowed.

            Hide features attributes Show features attributes object
            • doc_value_only_numeric boolean
            • doc_value_only_other boolean
            • synthetic_source boolean
            • tsdb boolean
        • install_format_schema_version string
        • install_source string Required

          Values are registry, upload, bundled, or custom.

        • install_status string Required

          Values are installed, installing, or install_failed.

        • installed_es array[object] Required
          Hide installed_es attributes Show installed_es attributes object
          • deferred boolean
          • id string Required
          • type string Required

            Values are index, index_template, component_template, ingest_pipeline, ilm_policy, data_stream_ilm_policy, transform, or ml_model.

          • version string
        • installed_kibana array[object] Required
          Hide installed_kibana attributes Show installed_kibana attributes object
          • 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.

        • installed_kibana_space_id string
        • latest_executed_state object

          Additional properties are allowed.

          Hide latest_executed_state attributes Show latest_executed_state attributes object
          • error string
          • name string
          • started_at string
        • latest_install_failed_attempts array[object]
          Hide latest_install_failed_attempts attributes Show latest_install_failed_attempts attributes object
          • created_at string Required
          • error object Required

            Additional properties are allowed.

            Hide error attributes Show error attributes object
            • message string Required
            • name string Required
            • stack string
          • target_version string Required
        • name string Required
        • namespaces array[string]
        • type string Required
        • updated_at string
        • verification_key_id string | null
        • verification_status string Required

          Values are unverified, verified, or unknown.

        • version string Required
      • internal boolean
      • keepPoliciesUpToDate boolean
      • latestVersion string
      • license string
      • licensePath string
      • name string Required
      • notice string
      • owner object

        Additional properties are allowed.

        Hide owner attributes Show owner attributes object
        • github string
        • type string

          Values are elastic, partner, or community.

      • path string
      • policy_templates array[object]

        Additional properties are allowed.

      • readme string
      • release string

        Values are ga, beta, or experimental.

      • screenshots array[object]
        Hide screenshots attributes Show screenshots attributes object
        • dark_mode boolean
        • path string
        • size string
        • src string Required
        • title string
        • type string
      • signature_path string
      • source object

        Additional properties are allowed.

        Hide source attribute Show source attribute object
        • license string Required
      • status string
      • title string Required

      • type string

        Any of:
        string-1 string string-2 string string-3 string string-4 string

        Value is integration.

        Value is input.

        Value is content.

      • vars array[object]

        Additional properties are allowed.

      • version string Required
  • 400 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
PUT /api/fleet/epm/packages/{pkgName}/{pkgVersion} 
curl \
 --request PUT 'https://<KIBANA_URL>/api/fleet/epm/packages/{pkgName}/{pkgVersion}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"keepPoliciesUpToDate":true}'