Get an inputs template

Base URL: https://{kibana_url}

GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs

Get an inputs template for a package, used to pre-populate package policy forms.

Required authorization

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

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/epm/templates/PKG_NAME/PKG_VERSION/inputs

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Inputs template for a package

{
  "inputs": [
    {
      "description": "Collect logs from log files",
      "title": "Collect logs from files",
      "type": "logfile",
      "vars": [
        {
          "name": "paths",
          "required": true,
          "title": "Paths",
          "type": "text"
        }
      ]
    }
  ]
}

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