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

Responses

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

  • item object Required

    Any of:

    object-1 object object-2 object object-3 object object-4 object

    Hide attributes Show attributes

    • allow_edit array[string]
    • ca_sha256 string | null
    • ca_trusted_fingerprint string | null
    • config_yaml string | null
    • hosts array[string(uri)] Required

      At least 1 element.

    • id string
    • is_default boolean

      Default value is false.

    • is_default_monitoring boolean

      Default value is false.

    • is_internal boolean
    • is_preconfigured boolean
    • name string Required
    • preset string

      Values are balanced, custom, throughput, scale, or latency.

    • proxy_id string | null
    • shipper object | null

      Additional properties are allowed.

      Hide shipper attributes Show shipper attributes object | null

      • compression_level number | null Required
      • disk_queue_compression_enabled boolean | null Required
      • disk_queue_enabled boolean | null

        Default value is false.

      • disk_queue_encryption_enabled boolean | null Required
      • disk_queue_max_size number | null Required
      • disk_queue_path string | null Required
      • loadbalance boolean | null Required
      • max_batch_bytes number | null Required
      • mem_queue_events number | null Required
      • queue_flush_timeout number | null Required
    • ssl object | null

      Additional properties are allowed.

      Hide ssl attributes Show ssl attributes object | null

      • certificate string
      • certificate_authorities array[string]
      • key string
      • verification_mode string

        Values are full, none, certificate, or strict.

    • type string Required

      Value is elasticsearch.

    Hide attributes Show attributes

    • allow_edit array[string]
    • ca_sha256 string | null
    • ca_trusted_fingerprint string | null
    • config_yaml string | null
    • hosts array[string(uri)] Required

      At least 1 element.

    • id string
    • is_default boolean

      Default value is false.

    • is_default_monitoring boolean

      Default value is false.

    • is_internal boolean
    • is_preconfigured boolean
    • name string Required
    • preset string

      Values are balanced, custom, throughput, scale, or latency.

    • proxy_id string | null
    • secrets object

      Additional properties are allowed.

      Hide secrets attribute Show secrets attribute object

      • service_token object | string

        Any of:

        object-1 object string-2 string

        Hide attribute Show attribute

        • id string Required
    • service_token string | null
    • shipper object | null

      Additional properties are allowed.

      Hide shipper attributes Show shipper attributes object | null

      • compression_level number | null Required
      • disk_queue_compression_enabled boolean | null Required
      • disk_queue_enabled boolean | null

        Default value is false.

      • disk_queue_encryption_enabled boolean | null Required
      • disk_queue_max_size number | null Required
      • disk_queue_path string | null Required
      • loadbalance boolean | null Required
      • max_batch_bytes number | null Required
      • mem_queue_events number | null Required
      • queue_flush_timeout number | null Required
    • ssl object | null

      Additional properties are allowed.

      Hide ssl attributes Show ssl attributes object | null

      • certificate string
      • certificate_authorities array[string]
      • key string
      • verification_mode string

        Values are full, none, certificate, or strict.

    • type string Required

      Value is remote_elasticsearch.

    Hide attributes Show attributes

    • allow_edit array[string]
    • ca_sha256 string | null
    • ca_trusted_fingerprint string | null
    • config_yaml string | null
    • hosts array[string] Required

      At least 1 element.

    • id string
    • is_default boolean

      Default value is false.

    • is_default_monitoring boolean

      Default value is false.

    • is_internal boolean
    • is_preconfigured boolean
    • name string Required
    • proxy_id string | null
    • secrets object

      Additional properties are allowed.

      Hide secrets attribute Show secrets attribute object

      • ssl object

        Additional properties are allowed.

        Hide ssl attribute Show ssl attribute object

        • key object | string

          Any of:

          object-1 object string-2 string

          Hide attribute Show attribute

          • id string Required
    • shipper object | null

      Additional properties are allowed.

      Hide shipper attributes Show shipper attributes object | null

      • compression_level number | null Required
      • disk_queue_compression_enabled boolean | null Required
      • disk_queue_enabled boolean | null

        Default value is false.

      • disk_queue_encryption_enabled boolean | null Required
      • disk_queue_max_size number | null Required
      • disk_queue_path string | null Required
      • loadbalance boolean | null Required
      • max_batch_bytes number | null Required
      • mem_queue_events number | null Required
      • queue_flush_timeout number | null Required
    • ssl object | null

      Additional properties are allowed.

      Hide ssl attributes Show ssl attributes object | null

      • certificate string
      • certificate_authorities array[string]
      • key string
      • verification_mode string

        Values are full, none, certificate, or strict.

    • type string Required

      Value is logstash.

    Hide attributes Show attributes

    • allow_edit array[string]
    • auth_type string Required

      Values are none, user_pass, ssl, or kerberos.

    • broker_timeout number
    • ca_sha256 string | null
    • ca_trusted_fingerprint string | null
    • client_id string
    • compression string

      Values are gzip, snappy, lz4, or none.

    • compression_level array | null | boolean | number | object | string Required

      Any of:

      array-1 array | null boolean-2 boolean | null number-3 number | null object-4 object | null string-5 string | null

      Additional properties are allowed.
    • config_yaml string | null

    • connection_type array | null | boolean | number | object | string Required

      Any of:

      array-1 array | null boolean-2 boolean | null number-3 number | null object-4 object | null string-5 string | null

      Additional properties are allowed.
    • hash object

      Additional properties are allowed.

      Hide hash attributes Show hash attributes object

      • hash string
      • random boolean
    • headers array[object]
      Hide headers attributes Show headers attributes object

      • key string Required
      • value string Required
    • hosts array[string] Required

      At least 1 element.

    • id string
    • is_default boolean

      Default value is false.

    • is_default_monitoring boolean

      Default value is false.

    • is_internal boolean
    • is_preconfigured boolean
    • key string
    • name string Required
    • partition string

      Values are random, round_robin, or hash.

    • password array | null | boolean | number | object | string Required

      Any of:

      array-1 array | null boolean-2 boolean | null number-3 number | null object-4 object | null string-5 string | null

      Additional properties are allowed.
    • proxy_id string | null
    • random object

      Additional properties are allowed.

      Hide random attribute Show random attribute object

      • group_events number
    • required_acks integer

      Values are 1, 0, or -1.

    • round_robin object

      Additional properties are allowed.

      Hide round_robin attribute Show round_robin attribute object

      • group_events number
    • sasl object | null

      Additional properties are allowed.

      Hide sasl attribute Show sasl attribute object | null

      • mechanism string

        Values are PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512.

    • secrets object

      Additional properties are allowed.

      Hide secrets attributes Show secrets attributes object

      • password object | string

        Any of:

        object-1 object string-2 string

        Hide attribute Show attribute

        • id string Required
      • ssl object

        Additional properties are allowed.

        Hide ssl attribute Show ssl attribute object

        • key object | string Required

          Any of:

          object-1 object string-2 string

          Hide attribute Show attribute

          • id string Required
    • shipper object | null

      Additional properties are allowed.

      Hide shipper attributes Show shipper attributes object | null

      • compression_level number | null Required
      • disk_queue_compression_enabled boolean | null Required
      • disk_queue_enabled boolean | null

        Default value is false.

      • disk_queue_encryption_enabled boolean | null Required
      • disk_queue_max_size number | null Required
      • disk_queue_path string | null Required
      • loadbalance boolean | null Required
      • max_batch_bytes number | null Required
      • mem_queue_events number | null Required
      • queue_flush_timeout number | null Required
    • ssl object | null

      Additional properties are allowed.

      Hide ssl attributes Show ssl attributes object | null

      • certificate string
      • certificate_authorities array[string]
      • key string
      • verification_mode string

        Values are full, none, certificate, or strict.

    • timeout number
    • topic string
    • topics array[object]

      At least 1 element.

      Hide topics attributes Show topics attributes object

      • topic string Required
      • when object

        Additional properties are allowed.

        Hide when attributes Show when attributes object

        • condition string
        • type string

          Values are equals, contains, or regexp.

    • type string Required

      Value is kafka.

    • username array | null | boolean | number | object | string Required

      Any of:

      array-1 array | null boolean-2 boolean | null number-3 number | null object-4 object | null string-5 string | null

      Additional properties are allowed.
    • 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