FleetOutputsClient¶

Client for the Kibana Fleet outputs and connectivity API.

This client manages where Elastic Agents send their data and how they reach the Elastic Stack: outputs (Elasticsearch, remote Elasticsearch, Logstash, Kafka), Fleet Server hosts, Fleet proxies, agent binary download sources, remote synced integrations status, and cloud connectors (technical preview in Kibana 9.4).

All methods accept an optional space_id to target a specific Kibana space.

class kibana._sync.client.fleet_outputs.FleetOutputsClient(client, default_space_id=None, validate_spaces=True)[source]¶

Bases: NamespaceClient

Client for the Kibana Fleet outputs and connectivity API.

Manages where Elastic Agents send their data and how they reach the Elastic Stack:

Outputs (/api/fleet/outputs): Elasticsearch, remote Elasticsearch, Logstash and Kafka destinations for agent data.
Fleet Server hosts (/api/fleet/fleet_server_hosts): the URLs agents use to contact Fleet Server.
Proxies (/api/fleet/proxies): Fleet proxies that sit between agents and outputs, Fleet Server or the agent binary source.
Agent binary download sources (/api/fleet/agent_download_sources): the locations agents download their binaries from.
Remote synced integrations (/api/fleet/remote_synced_integrations): status of integration syncing to remote Elasticsearch outputs.
Cloud connectors (/api/fleet/cloud_connectors): reusable cloud credentials (AWS/Azure/GCP) shared by agentless package policies.

Every method accepts an optional space_id to target a specific Kibana space (None targets the default space or the space the client is scoped to).

Example

>>> from kibana import Kibana
>>> client = Kibana("http://localhost:5601", api_key="...")
>>>
>>> # List outputs, then create and delete a Logstash output
>>> outputs = client.fleet_outputs.get_outputs()
>>> created = client.fleet_outputs.create_output(
...     name="my-logstash",
...     type="logstash",
...     hosts=["logstash.example.com:5044"],
... )
>>> client.fleet_outputs.delete_output(
...     output_id=created.body["item"]["id"]
... )

Managing Outputs

Outputs define the destinations agents send data to. Type-specific properties (Kafka authentication, remote Elasticsearch sync settings, …) are passed via fields:

from kibana import Kibana

client = Kibana("http://localhost:5601", api_key="your_api_key")

# List outputs (the default Elasticsearch output always exists)
outputs = client.fleet_outputs.get_outputs()
for output in outputs.body["items"]:
    print(output["id"], output["type"], output["is_default"])

# Create a Logstash output
created = client.fleet_outputs.create_output(
    name="my-logstash",
    type="logstash",
    hosts=["logstash.example.com:5044"],
)
output_id = created.body["item"]["id"]

# Create a Kafka output with type-specific fields
kafka = client.fleet_outputs.create_output(
    name="my-kafka",
    type="kafka",
    hosts=["kafka.example.com:9092"],
    fields={
        "auth_type": "user_pass",
        "username": "fleet",
        "password": "secret",
        "topic": "agent-events",
    },
)

# Rename, check health, then delete
client.fleet_outputs.update_output(output_id=output_id, name="renamed")
health = client.fleet_outputs.get_output_health(output_id=output_id)
print(health.body["state"])
client.fleet_outputs.delete_output(output_id=output_id)

Fleet Server Hosts and Proxies

# Create a proxy and a Fleet Server host that connects through it
proxy = client.fleet_outputs.create_proxy(
    name="my-proxy", url="https://proxy.example.com:3128"
)
host = client.fleet_outputs.create_fleet_server_host(
    name="my-fleet-server",
    host_urls=["https://fleet.example.com:8220"],
    proxy_id=proxy.body["item"]["id"],
)

# List, update and delete
hosts = client.fleet_outputs.get_fleet_server_hosts()
client.fleet_outputs.update_fleet_server_host(
    item_id=host.body["item"]["id"], name="renamed-fleet-server"
)
client.fleet_outputs.delete_fleet_server_host(
    item_id=host.body["item"]["id"]
)
client.fleet_outputs.delete_proxy(item_id=proxy.body["item"]["id"])

Agent Binary Download Sources

# Point agents at a private artifacts mirror
source = client.fleet_outputs.create_agent_download_source(
    name="my-mirror",
    host="https://artifacts.example.com/downloads/",
)
source_id = source.body["item"]["id"]

# name and host are required on every update
client.fleet_outputs.update_agent_download_source(
    source_id=source_id,
    name="my-mirror-renamed",
    host="https://artifacts.example.com/downloads/",
)
client.fleet_outputs.delete_agent_download_source(source_id=source_id)

Remote Synced Integrations

# Status of integrations synced to this cluster
status = client.fleet_outputs.get_remote_synced_integrations_status()
print(status.body["integrations"])

# Status reported by the remote cluster behind a
# remote_elasticsearch output with sync_integrations enabled
remote = client.fleet_outputs.get_remote_synced_integrations_remote_status(
    output_id="my-remote-output-id"
)

Cloud Connectors (Technical Preview)

Cloud connectors hold reusable cloud credentials. For AWS, the external_id var must be a secret reference:

created = client.fleet_outputs.create_cloud_connector(
    name="arn:aws:iam::123456789012:role/my-role",
    cloud_provider="aws",
    vars={
        "role_arn": {
            "value": "arn:aws:iam::123456789012:role/my-role",
            "type": "text",
        },
        "external_id": {
            "value": {"id": "AbCdEfGhIjKlMnOpQrSt", "isSecretRef": True},
            "type": "password",
        },
    },
)
connector_id = created.body["item"]["id"]

usage = client.fleet_outputs.get_cloud_connector_usage(
    cloud_connector_id=connector_id
)
client.fleet_outputs.delete_cloud_connector(
    cloud_connector_id=connector_id, force=True
)

__init__(client, default_space_id=None, validate_spaces=True)[source]¶

Initialize the FleetOutputsClient.

Parameters:

client (Kibana) – The parent Kibana client instance to delegate requests to.
default_space_id (str | None) – Optional default space ID for all operations.
validate_spaces (bool) – Whether to validate space existence before space-scoped operations (default: True).

Example

>>> fleet_outputs_client = FleetOutputsClient(kibana_client)

get_outputs(*, space_id=None, validate_spaces=None)[source]¶

Get outputs.

Lists all Fleet outputs, including the default Elasticsearch output.

Parameters:

space_id (str | None) – Optional space ID to scope the operation to.
validate_spaces (bool | None) – Override space validation setting for this operation.

Returns:

ObjectApiResponse containing items (list of outputs), plus page, perPage and total.

Raises:

BadRequestError – If the request is invalid.
AuthenticationException – If authentication fails.
AuthorizationException – If insufficient privileges.
SpaceNotFoundError – If the space doesn’t exist and validation is enabled.

Return type:

FleetOutputsClient¶

AsyncFleetOutputsClient¶