Get an inputs template

Base URL: https://{kibana_url}

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

Auth

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

Required privileges

Privileges integrations-read or fleet-setup or fleet-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
pkgName string required: Package name
pkgVersion string required: Package version

Query parameters

format enum · default: json: Output format for the inputs template: json, yml, or yaml; Values: json yml yaml
prerelease boolean: When true, allow prerelease versions
ignoreUnverified boolean: When true, return inputs even if the package signature cannot be verified

Responses

Successful response

application/json

Any of:

Bad Request

application/json

View as Markdown

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
}