Headers

• elastic-api-version string

  The version of the API to use

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

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Query parameters

• sys_monitoring boolean

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

    • advanced_settings object

      Additional properties are NOT allowed.

      Hide advanced_settings attributes Show advanced_settings attributes object

      • agent_download_target_directory
      • agent_download_timeout

        Default value is 2h.

      • agent_limits_go_max_procs
      • agent_logging_level

        Default value is info.

      • agent_logging_metrics_period

        Default value is 30s.

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

      • enabled boolean Required
      • name string Required
    • agents number
    • data_output_id string | null
    • description string
    • download_source_id string | null
    • fleet_server_host_id string | null
    • global_data_tags array[object]

      User defined data tags that are added to all of the inputs. The values can be strings or numbers.

      Hide global_data_tags attributes Show global_data_tags attributes object

      • name string Required

      • value string | number Required

        Any of:

        string-1 string number-2 number
    • has_fleet_server boolean
    • id string Required
    • inactivity_timeout number

      Minimum value is 0. Default value is 1209600.

    • is_default boolean
    • is_default_fleet_server boolean
    • is_managed boolean Required
    • is_preconfigured boolean
    • is_protected boolean Required

      Indicates whether the agent policy has tamper protection enabled. Default false.

    • keep_monitoring_alive boolean | null

      When set to true, monitoring will be enabled but logs/metrics collection will be disabled

      Default value is false.

    • monitoring_diagnostics object

      Additional properties are NOT allowed.

      Hide monitoring_diagnostics attributes Show monitoring_diagnostics attributes object

      • limit object

        Additional properties are NOT allowed.

        Hide limit attributes Show limit attributes object

        • burst number
        • interval string
      • uploader object

        Additional properties are NOT allowed.

        Hide uploader attributes Show uploader attributes object

        • init_dur string
        • max_dur string
        • max_retries number
    • monitoring_enabled array[string]

      Values are logs, metrics, or traces.

    • monitoring_http object

      Additional properties are NOT allowed.

      Hide monitoring_http attributes Show monitoring_http attributes object

      • buffer object

        Additional properties are NOT allowed.

        Hide buffer attribute Show buffer attribute object

        • enabled boolean

          Default value is false.

      • enabled boolean Required
      • host string
      • port number

        Minimum value is 0, maximum value is 65353.

    • monitoring_output_id string | null
    • monitoring_pprof_enabled boolean
    • name string Required

      Minimum length is 1.

    • namespace string Required

      Minimum length is 1.

    • overrides object | null

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

      Additional properties are allowed.

    • package_policies array[string] | array[object]

      Any of:

      array-1 array[string] array-2 array[object]

      This field is present only when retrieving a single agent policy, or when retrieving a list of agent policies with the ?full=true parameter

      Hide attributes Show attributes object

      • 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] Required
        Hide inputs attributes Show inputs 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
      • 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
      • updated_at string Required
      • updated_by 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
      • version string
    • revision number Required
    • schema_version string
    • space_ids array[string]
    • status string Required

      Values are active or inactive.

    • supports_agentless boolean | null

      Indicates whether the agent policy supports agentless integrations.

      Default value is false.

    • unenroll_timeout number

      Minimum value is 0.

    • unprivileged_agents number
    • updated_at string Required
    • updated_by string Required
    • 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