Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana Fleet outputs API

Fleet outputs APIs enable you to manage Fleet outputs, including creating, updating, and deleting output configurations, generating Logstash API keys, and monitoring output health.

Kibana Fleet outputs API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Fleet outputs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

7 operations 4 paths 14 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana Fleet outputs API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Fleet outputs 7

Fleet outputs APIs enable you to manage Fleet outputs, including creating, updating, and deleting output configurations, generating Logstash API keys, and monitoring output health.

POST
/api/fleet/logstash_api_keys
Generate a Logstash API key
post-fleet-logstash-api-keys 1 param → 200400
GET
/api/fleet/outputs
Get outputs
get-fleet-outputs → 200400
POST
/api/fleet/outputs
Create output
post-fleet-outputs 1 param body → 200400
DELETE
/api/fleet/outputs/{outputId}
Delete output
delete-fleet-outputs-outputid 2 params → 200400404
GET
/api/fleet/outputs/{outputId}
Get output
get-fleet-outputs-outputid 1 param → 200400404
PUT
/api/fleet/outputs/{outputId}
Update output
put-fleet-outputs-outputid 2 params body → 200400404
GET
/api/fleet/outputs/{outputId}/health
Get the latest output health
get-fleet-outputs-outputid-health 1 param → 200400

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Kibana_HTTP_APIs_new_output_kafka (37 properties), Kibana_HTTP_APIs_output_kafka (37 properties), Kibana_HTTP_APIs_update_output_kafka (37 properties), Kibana_HTTP_APIs_output_remote_elasticsearch (25 properties). Each schema is shown below with its type and property counts.

Kibana_HTTP_APIs_update_output_logstash
object
18 properties
Kibana_HTTP_APIs_new_output_kafka
object
37 properties 4 required
Kibana_HTTP_APIs_new_output_logstash
object
18 properties 3 required
Kibana_HTTP_APIs_new_output_remote_elasticsearch
object
25 properties 3 required
Kibana_HTTP_APIs_output_kafka
object
37 properties 4 required
Kibana_HTTP_APIs_new_output_elasticsearch
object
20 properties 3 required
Kibana_HTTP_APIs_output_remote_elasticsearch
object
25 properties 3 required
Kibana_HTTP_APIs_update_output_elasticsearch
object
20 properties
Kibana_HTTP_APIs_update_output_kafka
object
37 properties 1 required
Kibana_HTTP_APIs_output_ssl
object
4 properties
Kibana_HTTP_APIs_output_logstash
object
18 properties 3 required
Kibana_HTTP_APIs_output_elasticsearch
object
20 properties 3 required
Kibana_HTTP_APIs_output_shipper
object
10 properties 9 required
Kibana_HTTP_APIs_update_output_remote_elasticsearch
object
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-fleet-outputs-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API