Get a package

Base URL: https://{kibana_url}

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

Get information about a specific version of a package.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Query parameters

Responses

Successful response

application/json

item object required
metadata object

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/epm/packages/PKG_NAME/PKG_VERSION

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/epm/packages/${PKG_NAME}/${PKG_VERSION}" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Package details and installation status

{
  "item": {
    "assets": {
      "kibana": {
        "dashboard": [],
        "index_pattern": []
      }
    },
    "categories": [
      "cloud"
    ],
    "description": "Collect logs and metrics from Amazon Web Services",
    "name": "aws",
    "status": "installed",
    "title": "AWS",
    "version": "2.10.0"
  }
}

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