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.

Get a list of integration packages available in the registry.

[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.

Query parameters

  • category string

    Filter packages by category

  • prerelease boolean

    When true, include prerelease packages in the results

  • excludeInstallStatus boolean

    When true, exclude the install status from the response

  • withPackagePoliciesCount boolean

    When true, include the number of package policies per package

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • items array[object] Required

      Not more than 10000 elements.

      Hide items attributes Show items attributes object
      • categories array[string]

        Not more than 100 elements.

      • conditions object

        Additional properties are allowed.

        Hide conditions attributes Show conditions attributes object
        • deprecated object

          Additional properties are allowed.

          Hide deprecated attributes Show deprecated attributes object
          • description string Required
          • replaced_by object
            Hide replaced_by attribute Show replaced_by attribute object
            • * string Additional properties
          • since string
        • elastic object

          Additional properties are allowed.

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

            Not more than 10 elements.

          • subscription string
        • kibana object

          Additional properties are allowed.

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

        Not more than 1000 elements.

      • deprecated object

        Additional properties are allowed.

        Hide deprecated attributes Show deprecated attributes object
        • description string Required
        • replaced_by object
          Hide replaced_by attribute Show replaced_by attribute object
          • * string Additional properties
        • since string
      • description string
      • discovery object

        Additional properties are allowed.

        Hide discovery attributes Show discovery attributes object
        • datasets array[object]

          Not more than 100 elements.

          Hide datasets attribute Show datasets attribute object
          • name string Required
        • fields array[object]

          Not more than 100 elements.

          Hide fields attribute Show fields attribute object
          • name string Required
      • download string
      • format_version string
      • icons array[object]

        Not more than 100 elements.

        Hide icons attributes Show icons attributes object
        • dark_mode boolean
        • path string
        • size string
        • src string Required
        • title string
        • type string
      • id string Required
      • 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

            Not more than 100 elements.

            Hide * attributes Show * attributes object
            • deferred boolean
            • 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]

          Not more than 100 elements.

          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

          Not more than 10000 elements.

          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, ml_model, knowledge_base, or esql_view.

          • version string
        • installed_kibana array[object] Required

          Not more than 10000 elements.

          Hide installed_kibana attributes Show installed_kibana attributes object
          • deferred boolean
          • 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
        • is_rollback_ttl_expired boolean
        • 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]

          Not more than 10 elements.

          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]

          Not more than 100 elements.

        • previous_version string | null
        • rolled_back boolean
        • type string Required
        • updated_at string
        • verification_key_id string | null
        • verification_status string Required

          Values are unverified, verified, or unknown.

        • version string Required
      • integration string
      • internal boolean
      • latestVersion string
      • name string Required
      • 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]

        Not more than 1000 elements.

      • readme string
      • release string

        Values are ga, beta, or experimental.

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

      • var_groups array[object]

        Not more than 100 elements.

        Hide var_groups attributes Show var_groups attributes object
        • description string
        • name string Required
        • options array[object] Required

          Not more than 100 elements.

          Hide options attributes Show options attributes object
          • description string
          • hide_in_deployment_modes array[string]

            Not more than 2 elements. Values are default or agentless.

          • name string Required
          • title string Required
          • vars array[string] Required

            Not more than 100 elements.

        • selector_title string Required
        • title string Required
      • vars array[object]

        Not more than 1000 elements.

      • version string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/epm/packages 
curl \
 --request GET 'https://localhost:5601/api/fleet/epm/packages' \
 --header "Authorization: $API_KEY"
Response examples (200)
List of available integration packages 
{
  "items": [
    {
      "categories": [
        "cloud"
      ],
      "description": "Collect logs and metrics from Amazon Web Services",
      "id": "aws",
      "name": "aws",
      "status": "not_installed",
      "title": "AWS",
      "version": "2.10.0"
    }
  ],
  "searchExcluded": 0,
  "total": 1
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}