Headers

• elastic-api-version string

  The version of the API to use

  Value is 2023-10-31. Default value is 2023-10-31.

Path parameters

• packagePolicyId string Required

Query parameters

• format string

  Values are simplified or legacy.

Responses

• 200 application/json; Elastic-Api-Version=2023-10-31
  Hide response attribute Show response attribute object

  • item object Required

    Additional properties are NOT allowed.

    Hide item attributes Show item attributes object

    • agents number
    • created_at string Required
    • created_by string Required
    • description string

      Package policy description

    • elasticsearch object

      Additional properties are allowed.

      Hide elasticsearch attribute Show elasticsearch attribute object

      • privileges object

        Additional properties are allowed.

        Hide privileges attribute Show privileges attribute object

        • cluster array[string]
    • enabled boolean Required
    • id string Required

    • inputs array[object] | object Required

      Any of:

      array-1 array[object] object-2 object

      Hide attributes Show attributes object

      • compiled_input Required
      • config object

        Package variable (see integration documentation for more information)

        Hide config attribute Show config attribute object

        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object

          • frozen boolean
          • type string
          • value Required
      • enabled boolean Required
      • id string
      • keep_enabled boolean
      • policy_template string
      • streams array[object] Required
        Hide streams attributes Show streams attributes object

        • compiled_stream Required
        • config object

          Package variable (see integration documentation for more information)

          Hide config attribute Show config attribute object

          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attributes Show * attributes object

            • frozen boolean
            • type string
            • value Required
        • data_stream object Required

          Additional properties are NOT allowed.

          Hide data_stream attributes Show data_stream attributes object

          • dataset string Required
          • elasticsearch object

            Additional properties are NOT allowed.

            Hide elasticsearch attributes Show elasticsearch attributes object

            • dynamic_dataset boolean
            • dynamic_namespace boolean
            • privileges object

              Additional properties are NOT allowed.

              Hide privileges attribute Show privileges attribute object

              • indices array[string]
          • type string Required
        • enabled boolean Required
        • id string
        • keep_enabled boolean
        • release string

          Values are ga, beta, or experimental.

        • vars object

          Package variable (see integration documentation for more information)

          Hide vars attribute Show vars attribute object

          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attributes Show * attributes object

            • frozen boolean
            • type string
            • value Required
      • type string Required
      • vars object

        Package variable (see integration documentation for more information)

        Hide vars attribute Show vars attribute object

        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object

          • frozen boolean
          • type string
          • value Required

      Package policy inputs (see integration documentation to know what inputs are available)

      Hide attribute Show attribute

      • * object Additional properties

        Additional properties are NOT allowed.

        Hide * attributes Show * attributes object

        • enabled boolean

          enable or disable that input, (default to true)

        • streams object

          Input streams (see integration documentation to know what streams are available)

          Hide streams attribute Show streams attribute object

          • * object Additional properties

            Additional properties are NOT allowed.

            Hide * attributes Show * attributes object

            • enabled boolean

              enable or disable that stream, (default to true)

            • vars object

              Input/stream level variable (see integration documentation for more information)

        • vars object

          Input/stream level variable (see integration documentation for more information)

    • is_managed boolean
    • name string Required

      Package policy name (should be unique)

    • namespace string

      The package policy namespace. Leave blank to inherit the agent policy's namespace.

    • output_id string | null
    • overrides object | null

      Override settings that are defined in the package policy. The override option should be used only in unusual circumstances and not as a routine procedure.

      Additional properties are NOT allowed.

      Hide overrides attribute Show overrides attribute object | null

      • inputs object

        Additional properties are allowed.

    • package object

      Additional properties are NOT allowed.

      Hide package attributes Show package attributes object

      • experimental_data_stream_features array[object]
        Hide experimental_data_stream_features attributes Show experimental_data_stream_features attributes object

        • data_stream string Required
        • features object Required

          Additional properties are NOT allowed.

          Hide features attributes Show features attributes object

          • doc_value_only_numeric boolean
          • doc_value_only_other boolean
          • synthetic_source boolean
          • tsdb boolean
      • name string Required

        Package name

      • requires_root boolean
      • title string
      • version string Required

        Package version

    • policy_id string | null Deprecated

      Agent policy ID where that package policy will be added

    • policy_ids array[string]

      Agent policy IDs where that package policy will be added

    • revision number Required
    • secret_references array[object]
      Hide secret_references attribute Show secret_references attribute object

      • id string Required
    • spaceIds array[string]
    • updated_at string Required
    • updated_by string Required

    • vars object

      Any of:

      object-1 object object-2 object

      Package variable (see integration documentation for more information)

      Hide attribute Show attribute

      • * object Additional properties

        Additional properties are NOT allowed.

        Hide * attributes Show * attributes object

        • frozen boolean
        • type string
        • value Required

      Input/stream level variable (see integration documentation for more information)

    • version string
• 400 application/json; Elastic-Api-Version=2023-10-31
  Hide response attributes Show response attributes object

  • error string
  • message string Required
  • statusCode number
• 404 application/json; Elastic-Api-Version=2023-10-31
  Hide response attribute Show response attribute object

  • message string Required