Update output by ID

PUT /api/fleet/outputs/{outputId}

Headers

  • kbn-xsrf string Required

    Kibana's anti Cross-Site Request Forgery token. Can be any string value.

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

Body object

One of:

Responses

PUT /api/fleet/outputs/{outputId}
curl \
 -X PUT https://localhost:5601/api/fleet/outputs/{outputId} \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
 -H "kbn-xsrf: string"
# Headers
kbn-xsrf: string

# Payload
{
  "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"
}
# Headers
kbn-xsrf: string

# Payload
{
  "auth_type": "string",
  "broker_timeout": 42.0,
  "ca_sha256": "string",
  "ca_trusted_fingerprint": "string",
  "client_id": "string",
  "compression": "string",
  "compression_level": 42.0,
  "config": {},
  "config_yaml": "string",
  "connection_type": "plaintext",
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "hosts": [
    "string"
  ],
  "id": "string",
  "is_default": true,
  "is_default_monitoring": true,
  "is_internal": true,
  "key": "string",
  "name": "string",
  "partition": "string",
  "password": "string",
  "proxy_id": "string",
  "random": {
    "group_events": 42.0
  },
  "required_acks": 42.0,
  "round_robin": {
    "group_events": 42.0
  },
  "sasl": {
    "mechanism": "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",
    "verification_mode": "none"
  },
  "timeout": 42.0,
  "topic": "string",
  "topics": [
    {
      "topic": "string",
      "when": {
        "condition": "string",
        "type": "string"
      }
    }
  ],
  "type": "kafka",
  "username": "string",
  "version": "string"
}
# Headers
kbn-xsrf: string

# Payload
{
  "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",
  "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": "logstash"
}
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
}