Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • items array[object]
    One of:

    elasticsearch object kafka object logstash object remote_elasticsearch object

    Hide attributes Show attributes

    • ca_sha256 string
    • ca_trusted_fingerprint string
    • config object
    • config_yaml string
    • hosts array[string]
    • id string
    • is_default boolean
    • is_default_monitoring boolean
    • is_internal boolean
    • name string Required
    • preset string

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

    • proxy_id string
    • shipper object
      Hide shipper attributes Show shipper attributes object

      • compression_level number
      • disk_queue_compression_enabled boolean
      • disk_queue_enabled boolean
      • disk_queue_encryption_enabled boolean
      • disk_queue_max_size number
      • disk_queue_path string
      • loadbalance boolean
    • ssl object
      Hide ssl attributes Show ssl attributes object

      • certificate string
      • certificate_authorities array[string]
      • key string
    • type string Discriminator

      Value is elasticsearch.

    Hide attributes Show attributes

    • auth_type string Required
    • broker_timeout number
    • ca_sha256 string
    • ca_trusted_fingerprint string
    • client_id string
    • compression string
    • compression_level number
    • config object
    • config_yaml string
    • connection_type string

      Values are plaintext or encryption.

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

      • key string
      • value string
    • hosts array[string] Required
    • id string
    • is_default boolean
    • is_default_monitoring boolean
    • is_internal boolean
    • key string
    • name string Required
    • partition string
    • password string
    • proxy_id string
    • random object
      Hide random attribute Show random attribute object

      • group_events number
    • required_acks number
    • round_robin object
      Hide round_robin attribute Show round_robin attribute object

      • group_events number
    • sasl object
      Hide sasl attribute Show sasl attribute object

      • mechanism string
    • secrets object
      Hide secrets attributes Show secrets attributes object

      • password string
      • ssl object
        Hide ssl attribute Show ssl attribute object

        • key string
    • shipper object
      Hide shipper attributes Show shipper attributes object

      • compression_level number
      • disk_queue_compression_enabled boolean
      • disk_queue_enabled boolean
      • disk_queue_encryption_enabled boolean
      • disk_queue_max_size number
      • disk_queue_path string
      • loadbalance boolean
    • ssl object
      Hide ssl attributes Show ssl attributes object

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

        Values are none, full, certificate, or strict.

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

      Use topic instead.

      Hide topics attributes Show topics attributes object

      • topic string
      • when object Deprecated

        Deprecated, kafka output do not support conditionnal topics anymore.

        Hide when attributes Show when attributes object Deprecated

        • condition string
        • type string
    • type string Required Discriminator

      Value is kafka.

    • username string
    • version string

    Hide attributes Show attributes

    • ca_sha256 string
    • ca_trusted_fingerprint string
    • config object
    • config_yaml string
    • hosts array[string] Required
    • id string
    • is_default boolean
    • is_default_monitoring boolean
    • is_internal boolean
    • name string Required
    • proxy_id string
    • secrets object
      Hide secrets attribute Show secrets attribute object

      • ssl object
        Hide ssl attribute Show ssl attribute object

        • key string
    • shipper object
      Hide shipper attributes Show shipper attributes object

      • compression_level number
      • disk_queue_compression_enabled boolean
      • disk_queue_enabled boolean
      • disk_queue_encryption_enabled boolean
      • disk_queue_max_size number
      • disk_queue_path string
      • loadbalance boolean
    • ssl object
      Hide ssl attributes Show ssl attributes object

      • certificate string
      • certificate_authorities array[string]
      • key string
    • type string Required Discriminator

      Value is logstash.

    Hide attributes Show attributes

    • hosts array[string]
    • id string
    • is_default boolean
    • is_default_monitoring boolean
    • is_internal boolean
    • name string Required
    • secrets object
      Hide secrets attribute Show secrets attribute object

      • service_token string
    • service_token string
    • type string Discriminator

      Value is remote_elasticsearch.

  • page integer
  • perPage integer
  • total integer
• 400 application/json

  Generic Error

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode number