Get output by ID

GET /api/fleet/outputs/{outputId}

Path parameters

outputId string Required

Responses

200 application/json; Elastic-Api-Version=2023-10-31

OK
Hide response attribute Show response attribute object
- item object
  
  One of:
  Fleet_output_create_request_elasticsearch object Fleet_output_create_request_kafka object Fleet_output_create_request_logstash object Fleet_output_create_request_remote_elasticsearch object
  
  Hide attributes Show attributes
  
  ca_sha256 string
  
  ca_trusted_fingerprint string
  
  config object
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  Hide random attribute Show random attribute object
  
  group_events number
  
  required_acks number
  
  round_robin object
  
  Additional properties are allowed.
  
  Hide round_robin attribute Show round_robin attribute object
  
  group_events number
  
  sasl object
  
  Additional properties are allowed.
  
  Hide sasl attribute Show sasl attribute object
  
  mechanism string
  
  secrets object
  
  Additional properties are allowed.
  
  Hide secrets attributes Show secrets attributes object
  
  password string
  
  ssl object
  
  Additional properties are allowed.
  
  Hide ssl attribute Show ssl attribute object
  
  key string
  
  shipper object
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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.
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  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 string
  
  shipper object
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  Hide secrets attribute Show secrets attribute object
  
  service_token string
  
  service_token string
  
  type string Discriminator
  
  Value is remote_elasticsearch.
400 application/json; Elastic-Api-Version=2023-10-31

Generic Error
Hide response attributes Show response attributes object
- error string
- message string
- statusCode number

GET /api/fleet/outputs/{outputId}

curl \
 --request GET https://localhost:5601/api/fleet/outputs/{outputId} \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "item": {
    "ca_sha256": "string",
    "ca_trusted_fingerprint": "string",
    "config": {},
    "config_yaml": "string",
    "hosts": [
      "string"
    ],
    "id": "string",
    "is_default": true,
    "is_default_monitoring": true,
    "is_internal": true,
    "name": "string",
    "preset": "balanced",
    "proxy_id": "string",
    "shipper": {
      "compression_level": 42.0,
      "disk_queue_compression_enabled": true,
      "disk_queue_enabled": true,
      "disk_queue_encryption_enabled": true,
      "disk_queue_max_size": 42.0,
      "disk_queue_path": "string",
      "loadbalance": true
    },
    "ssl": {
      "certificate": "string",
      "certificate_authorities": [
        "string"
      ],
      "key": "string"
    },
    "type": "elasticsearch"
  }
}

Response examples (400)

{
  "error": "string",
  "message": "string",
  "statusCode": 42.0
}

Get output by ID

Path parameters

Responses

item object