List packages

View as Markdown
GET /api/fleet/epm/packages
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Query parameters

  • excludeInstallStatus boolean

    Whether to exclude the install status of each package. Enabling this option will opt in to caching for the response via cache-control headers. If you don't need up-to-date installation info for a package, and are querying for a list of available packages, providing this flag can improve performance substantially.

    Default value is false.

  • prerelease boolean

    Whether to return prerelease versions of packages (e.g. beta, rc, preview)

    Default value is false.

  • experimental boolean Deprecated

    Default value is false.

  • category string

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • description string Required
      • download string Required
      • icons string Required
      • installationInfo object
        Hide installationInfo attributes Show installationInfo attributes object
        • 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
          • features object
            Hide features attributes Show features attributes object
            • doc_value_only_numeric boolean | null
            • doc_value_only_other boolean | null
            • synthetic_source boolean | null
            • tsdb boolean | null
        • install_format_schema_version string
        • install_kibana_space_id string
        • install_source string Required

          Values are registry, upload, or bundled.

        • install_status string Required

          Values are installed, installing, or install_failed.

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

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

        • installed_kibana object Required
          Hide installed_kibana attributes Show installed_kibana attributes object
          • id string
          • type string

            Values are dashboard, visualization, search, index-pattern, map, lens, ml-module, security-rule, or csp_rule_template.

        • latest_executed_state object

          Latest successfully executed state in package install state machine

          Hide latest_executed_state attributes Show latest_executed_state attributes object
          • error string
          • name string

            Values are create_restart_installation, install_kibana_assets, install_ilm_policies, install_ml_model, install_index_template_pipelines, remove_legacy_templates, update_current_write_indices, install_transforms, delete_previous_pipelines, save_archive_entries_from_assets_map, or update_so.

          • started_at string
        • latest_install_failed_attempts array[object] Required

          Latest failed install errors

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

          Values are verified, unverified, or unknown.

        • version string Required
      • name string Required
      • path string Required
      • savedObject object Deprecated
      • status string Required
      • title string Required
      • type string Required
      • version string Required
    • response array[object] Deprecated
      Hide response attributes Show response attributes object
      • description string Required
      • download string Required
      • icons string Required
      • installationInfo object
        Hide installationInfo attributes Show installationInfo attributes object
        • 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
          • features object
            Hide features attributes Show features attributes object
            • doc_value_only_numeric boolean | null
            • doc_value_only_other boolean | null
            • synthetic_source boolean | null
            • tsdb boolean | null
        • install_format_schema_version string
        • install_kibana_space_id string
        • install_source string Required

          Values are registry, upload, or bundled.

        • install_status string Required

          Values are installed, installing, or install_failed.

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

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

        • installed_kibana object Required
          Hide installed_kibana attributes Show installed_kibana attributes object
          • id string
          • type string

            Values are dashboard, visualization, search, index-pattern, map, lens, ml-module, security-rule, or csp_rule_template.

        • latest_executed_state object

          Latest successfully executed state in package install state machine

          Hide latest_executed_state attributes Show latest_executed_state attributes object
          • error string
          • name string

            Values are create_restart_installation, install_kibana_assets, install_ilm_policies, install_ml_model, install_index_template_pipelines, remove_legacy_templates, update_current_write_indices, install_transforms, delete_previous_pipelines, save_archive_entries_from_assets_map, or update_so.

          • started_at string
        • latest_install_failed_attempts array[object] Required

          Latest failed install errors

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

          Values are verified, unverified, or unknown.

        • version string Required
      • name string Required
      • path string Required
      • savedObject object Deprecated
      • status string Required
      • title string Required
      • type string Required
      • version string Required
  • 400 application/json

    Generic Error

    Hide response attributes Show response attributes object
    • error string
    • message string
    • statusCode number
GET /api/fleet/epm/packages 
curl \
 --request GET 'https://localhost:5601/api/fleet/epm/packages' \
 --header "Authorization: $API_KEY"