GET /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

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

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

Path parameters

  • pkgName string Required

    Package name

  • pkgVersion string Required

    Package version

Query parameters

  • format string

    Output format for the inputs template: json, yml, or yaml

    Values are json, yml, or yaml. Default value is json.

  • prerelease boolean

    When true, allow prerelease versions

  • ignoreUnverified boolean

    When true, return inputs even if the package signature cannot be verified

Responses

  • 200 application/json

    Successful response

    Any of:
    string-1 string object-2 object
  • 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/templates/{pkgName}/{pkgVersion}/inputs 
curl \
 --request GET 'https://localhost:5601/api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs' \
 --header "Authorization: $API_KEY"
Response examples (200)
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"
        }
      ]
    }
  ]
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}