Get package

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

Path parameters

Query parameters

  • Ignore if the package is fails signature verification

  • full boolean

    Return all fields from the package manifest, not just those supported by the Elastic Package Registry

  • prerelease boolean

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

    Default value is false.

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    OK

    Hide response attributes Show response attributes object
    • item object

      Additional properties are allowed.

      Hide item attributes Show item attributes object
      • agent object

        Additional properties are allowed.

        Hide agent attribute Show agent attribute object
        • Additional properties are allowed.

          Hide privileges attribute Show privileges attribute object
      • asset_tags array[object]
        Hide asset_tags attributes Show asset_tags attributes object
      • assets array[string] Required
      • categories array[string] Required
      • conditions object Required

        Additional properties are allowed.

        Hide conditions attributes Show conditions attributes object
        • Additional properties are allowed.

          Hide elasticsearch attribute Show elasticsearch attribute object
          • Values are basic, gold, platinum, or enterprise.

        • kibana object

          Additional properties are allowed.

          Hide kibana attribute Show kibana attribute object
      • data_streams array[object]
        Hide data_streams attributes Show data_streams attributes object
      • description string Required
      • Additional properties are allowed.

        Hide discovery attribute Show discovery attribute object
        • fields array[object]
          Hide fields attribute Show fields attribute object
      • download string Required
      • Additional properties are allowed.

        Hide elasticsearch attribute Show elasticsearch attribute object
        • Additional properties are allowed.

          Hide privileges attribute Show privileges attribute object
      • format_version string Required
      • icons array[string]
      • internal boolean
      • name string Required
      • owner object Required

        Additional properties are allowed.

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

          Values are elastic, partner, or community.

      • path string Required
      • readme string
      • release string Deprecated

        release label is deprecated, derive from the version instead (packages follow semver)

        Values are experimental, beta, or ga.

      • screenshots array[object]
        Hide screenshots attributes Show screenshots attributes object
      • source object

        Additional properties are allowed.

        Hide source attribute Show source attribute object
        • license string

          Values are Apache-2.0 or Elastic-2.0.

      • title string Required
      • type string Required

        Values are integration, input, or content.

      • version string Required
    • notice string
    • savedObject object Required Deprecated

      Additional properties are allowed.

    • status string Required

      Values are installed, installing, install_failed, or not_installed.

  • 400 application/json; Elastic-Api-Version=2023-10-31

    Generic Error

    Hide response attributes Show response attributes object
GET /api/fleet/epm/packages/{pkgName}/{pkgVersion}
curl \
 -X GET https://localhost:5601/api/fleet/epm/packages/{pkgName}/{pkgVersion}
Response examples (200)
{
  "item": {
    "agent": {
      "privileges": {
        "root": true
      }
    },
    "asset_tags": [
      {
        "asset_ids": [
          "string"
        ],
        "asset_types": [
          "string"
        ],
        "text": "string"
      }
    ],
    "assets": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "conditions": {
      "elasticsearch": {
        "subscription": "basic"
      },
      "kibana": {
        "versions": "string"
      }
    },
    "data_streams": [
      {
        "ingeset_pipeline": "string",
        "name": "string",
        "package": "string",
        "release": "string",
        "title": "string",
        "type": "string",
        "vars": [
          {
            "default": "string",
            "name": "string"
          }
        ]
      }
    ],
    "description": "string",
    "discovery": {
      "fields": [
        {
          "name": "string"
        }
      ]
    },
    "download": "string",
    "elasticsearch": {
      "privileges": {
        "cluster": [
          "string"
        ]
      }
    },
    "format_version": "string",
    "icons": [
      "string"
    ],
    "internal": true,
    "name": "string",
    "owner": {
      "github": "string",
      "type": "elastic"
    },
    "path": "string",
    "readme": "string",
    "release": "experimental",
    "screenshots": [
      {
        "path": "string",
        "size": "string",
        "src": "string",
        "title": "string",
        "type": "string"
      }
    ],
    "source": {
      "license": "Apache-2.0"
    },
    "title": "string",
    "type": "integration",
    "version": "string"
  },
  "keepPoliciesUpToDate": true,
  "latestVersion": "string",
  "licensePath": "string",
  "notice": "string",
  "savedObject": {},
  "status": "installed"
}
Response examples (400)
{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}