Create output

Base URL
https://{kibana_url}
  • POST /api/fleet/outputs
  • POST /s/{space_id}/api/fleet/outputs
Auth

Create a new Fleet output.

Required authorization

Privileges fleet-settings-all

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

One of:
type: elasticsearch
type enum required
Values: elasticsearch
allow_edit string[] · max items: 1000
ca_sha256 string nullable
ca_trusted_fingerprint string nullable
config_yaml string nullable
hosts string[] · format: uri · min items: 1 · max items: 100 required
id string
is_default boolean · default: false
is_default_monitoring boolean · default: false
is_internal boolean
is_preconfigured boolean
name string required
otel_disable_beatsauth boolean nullable
otel_exporter_config_yaml string nullable
preset enum
Values: balanced custom throughput scale latency
proxy_id string nullable
secrets object
ssl object
key union anyOf
Any of:
hash string
id string required
shipper object
compression_level number · default: null nullable
disk_queue_compression_enabled boolean · default: null nullable
disk_queue_enabled boolean · default: null nullable
disk_queue_encryption_enabled boolean · default: null nullable
disk_queue_max_size number · default: null nullable
disk_queue_path string · default: null nullable
loadbalance boolean · default: null nullable
max_batch_bytes number · default: null nullable
mem_queue_events number · default: null nullable
queue_flush_timeout number · default: null nullable
ssl object
certificate string
certificate_authorities string[] · max items: 10
key string
verification_mode enum
Values: full none certificate strict
write_to_logs_streams boolean nullable

Responses

Successful response

application/json
item union oneOf required
One of: (determined by type)
type: elasticsearch
type enum required
Values: elasticsearch
allow_edit string[] · max items: 1000
ca_sha256 string nullable
ca_trusted_fingerprint string nullable
config_yaml string nullable
hosts string[] · format: uri · min items: 1 · max items: 100 required
id string
is_default boolean · default: false
is_default_monitoring boolean · default: false
is_internal boolean
is_preconfigured boolean
name string required
otel_disable_beatsauth boolean nullable
otel_exporter_config_yaml string nullable
preset enum
Values: balanced custom throughput scale latency
proxy_id string nullable
secrets object
ssl object
key union anyOf
Any of:
hash string
id string required
shipper object
compression_level number · default: null nullable
disk_queue_compression_enabled boolean · default: null nullable
disk_queue_enabled boolean · default: null nullable
disk_queue_encryption_enabled boolean · default: null nullable
disk_queue_max_size number · default: null nullable
disk_queue_path string · default: null nullable
loadbalance boolean · default: null nullable
max_batch_bytes number · default: null nullable
mem_queue_events number · default: null nullable
queue_flush_timeout number · default: null nullable
ssl object
certificate string
certificate_authorities string[] · max items: 10
key string
verification_mode enum
Values: full none certificate strict
write_to_logs_streams boolean nullable

Bad Request

application/json
attributes object required
error string
errorType string
message string required
statusCode number
Base URL
https://{kibana_url}