Headers
-
elastic-api-version string
The version of the API to use
Value is
2023-10-31
. Default value is2023-10-31
.
Responses
-
200 application/json; Elastic-Api-Version=2023-10-31
Hide response attribute Show response attribute object
item object Required
Any of: Hide attributes Show attributes
-
allow_edit array[string]
-
ca_sha256 string | null
-
ca_trusted_fingerprint string | null
-
config_yaml string | null
-
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
-
preset string
Values are
balanced
,custom
,throughput
,scale
, orlatency
. -
proxy_id string | null
-
shipper object | null
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object | null
-
disk_queue_enabled boolean | null
Default value is
false
.
-
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
, orstrict
.
-
-
Value is
elasticsearch
.
Hide attributes Show attributes
-
allow_edit array[string]
-
ca_sha256 string | null
-
ca_trusted_fingerprint string | null
-
config_yaml string | null
-
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
-
preset string
Values are
balanced
,custom
,throughput
,scale
, orlatency
. -
proxy_id string | null
-
secrets object
Additional properties are allowed.
Hide secrets attribute Show secrets attribute object
service_token object | string
Any of: Hide attribute Show attribute
-
service_token string | null
-
shipper object | null
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object | null
-
disk_queue_enabled boolean | null
Default value is
false
.
-
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
, orstrict
.
-
-
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
-
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
-
proxy_id string | null
-
secrets object
Additional properties are allowed.
Hide secrets attribute Show secrets attribute object
-
shipper object | null
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object | null
-
disk_queue_enabled boolean | null
Default value is
false
.
-
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
, orstrict
.
-
-
Value is
logstash
.
Hide attributes Show attributes
-
allow_edit array[string]
-
Values are
none
,user_pass
,ssl
, orkerberos
. -
broker_timeout number
-
ca_sha256 string | null
-
ca_trusted_fingerprint string | null
-
client_id string
-
compression string
Values are
gzip
,snappy
,lz4
, ornone
. compression_level array | null | boolean | number | object | string Required
Any of: Additional properties are allowed.
-
config_yaml string | null
connection_type array | null | boolean | number | object | string Required
Any of: Additional properties are allowed.
-
hash object
Additional properties are allowed.
-
headers array[object]
-
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
-
partition string
Values are
random
,round_robin
, orhash
. -
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
, orSCRAM-SHA-512
.
-
-
secrets object
Additional properties are allowed.
Hide secrets attributes Show secrets attributes object
-
shipper object | null
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object | null
-
disk_queue_enabled boolean | null
Default value is
false
.
-
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
, orstrict
.
-
-
timeout number
-
topic string
-
topics array[object]
At least
1
element. -
Value is
kafka
. -
version string
-
-
400 application/json; Elastic-Api-Version=2023-10-31
Hide response attributes Show response attributes object
-
error string
-
statusCode number
-
curl \
-X GET https://localhost:5601/api/fleet/outputs/{outputId} \
-H "elastic-api-version: 2023-10-31"
{
"item": {
"allow_edit": [
"string"
],
"ca_sha256": "string",
"ca_trusted_fingerprint": "string",
"config_yaml": "string",
"hosts": [
"https://example.com"
],
"id": "string",
"is_default": false,
"is_default_monitoring": false,
"is_internal": true,
"is_preconfigured": true,
"name": "string",
"preset": "balanced",
"proxy_id": "string",
"shipper": {
"compression_level": 42.0,
"disk_queue_compression_enabled": true,
"disk_queue_enabled": false,
"disk_queue_encryption_enabled": true,
"disk_queue_max_size": 42.0,
"disk_queue_path": "string",
"loadbalance": true,
"max_batch_bytes": 42.0,
"mem_queue_events": 42.0,
"queue_flush_timeout": 42.0
},
"ssl": {
"certificate": "string",
"certificate_authorities": [
"string"
],
"key": "string",
"verification_mode": "full"
},
"type": "elasticsearch"
}
}
{
"error": "string",
"message": "string",
"statusCode": 42.0
}