Spaces method and path for this operation:
Refer to Spaces for more information.
Get output by ID.
[Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read.
Responses
-
Successful response
Hide response attribute Show response attribute object
- item
object Required One of: Hide attributes Show attributes
-
Not more than
1000elements. -
At least
1but not more than100elements. -
Default value is
false. -
Default value is
false. -
Values are
balanced,custom,throughput,scale, orlatency. -
Additional properties are allowed.
Hide secrets attribute Show secrets attribute object
-
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object
-
Additional properties are allowed.
-
Value is
elasticsearch.
Hide attributes Show attributes
-
Not more than
1000elements. -
At least
1but not more than100elements. -
Default value is
false. -
Default value is
false. -
Values are
balanced,custom,throughput,scale, orlatency. -
Additional properties are allowed.
Hide secrets attributes Show secrets attributes object
-
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object
-
Additional properties are allowed.
-
Value is
remote_elasticsearch.
Hide attributes Show attributes
-
Not more than
1000elements. -
At least
1but not more than100elements. -
Default value is
false. -
Default value is
false. -
Additional properties are allowed.
Hide secrets attribute Show secrets attribute object
-
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object
-
Additional properties are allowed.
-
Value is
logstash.
Hide attributes Show attributes
-
Not more than
1000elements. -
Values are
none,user_pass,ssl,kerberos, oroauth2. -
Values are
gzip,snappy,lz4, ornone. -
Values are
plaintextorencryption. -
Additional properties are allowed.
-
Not more than
100elements. -
At least
1but not more than100elements. -
Default value is
false. -
Default value is
false. -
Additional properties are allowed.
Hide kerberos attributes Show kerberos attributes object | null
-
How the agent authenticates with Kerberos: a keytab file, or a username and password.
Values are
keytaborpassword. -
Path to the Kerberos configuration file (
krb5.conf) on the agent host.Minimum length is
1. -
Whether to use Kerberos FAST authentication. This can conflict with some Active Directory installations. It defaults to
falsewhen not set. -
Path to the keytab file on the agent host. Required when
auth_typeiskeytab. -
Kerberos realm. This is usually the domain name in uppercase.
Minimum length is
1. -
Kerberos service name of the Kafka brokers.
-
Kerberos username. Required when
auth_typeispassword; the password is set insecrets.kerberos.password.
-
-
Additional properties are allowed.
Hide oauth2 attributes Show oauth2 attributes object | null
-
How many seconds before a token's expiry the agent requests a new one. It defaults to
300when not set.Minimum value is
0, maximum value is86400. -
Values are
client_credentialsorurn:ietf:params:oauth:grant-type:jwt-bearer. -
Not more than
100elements. -
Values are
RS256,RS384, orRS512. -
How long, in seconds, a request to the token endpoint can take before it times out. There is no limit when it is not set.
Minimum value is
0, maximum value is86400. -
Additional properties are allowed.
-
Minimum length is
1.
-
Values are
random,round_robin, orhash. -
Kafka outputs do not support proxy configuration. This field is accepted for backwards compatibility but is ignored — it is cleared to null on save and has no effect on the compiled agent policy.
-
Additional properties are allowed.
-
Values are
1,0, or-1. -
Additional properties are allowed.
-
Additional properties are allowed.
-
Additional properties are allowed.
Hide secrets attributes Show secrets attributes object
-
Additional properties are allowed.
Hide shipper attributes Show shipper attributes object
-
Additional properties are allowed.
-
Value is
kafka.
Hide attributes Show attributes
-
Not more than
1000elements. -
Default value is
false. -
Default value is
false. - otlp_exporter
object Required One of: Hide attributes Show attributes
-
Maximum length is
256. -
Maximum length is
256. -
Values are
gzip,snappy,zstd, ornone. -
Maximum length is
2048. -
Additional properties are allowed.
-
Value is
grpc. -
Additional properties are allowed.
Hide retry_on_failure attributes Show retry_on_failure attributes object | null
-
Additional properties are allowed.
Hide sending_queue attributes Show sending_queue attributes object | null
-
Additional properties are allowed.
Hide batch attributes Show batch attributes object | null
-
Maximum length is
64. -
Additional properties are allowed.
-
Values are
itemsorbytes.
-
-
Values are
requests,items, orbytes.
-
-
Maximum length is
64. -
Additional properties are allowed.
Hide tls attributes Show tls attributes object | null
-
Maximum length is
4096. -
Maximum length is
65536. -
Maximum length is
4096. -
Maximum length is
65536. -
Not more than
100elements. Maximum length of each is256. -
Not more than
4elements. Values areX25519,P521,P256, orP384. -
Maximum length is
4096. -
Maximum length is
10. -
Maximum length is
10. -
Maximum length is
64. -
Maximum length is
256. -
Additional properties are allowed.
-
-
Maximum length is
256.
Hide attributes Show attributes
-
Values are
gzipornone. -
Additional properties are allowed.
-
Additional properties are allowed.
-
Values are
protoorjson. -
Maximum length is
2048. -
Maximum length is
64. -
Maximum length is
64. -
Maximum length is
64. -
Maximum length is
2048. -
Maximum length is
2048. -
Maximum length is
2048. -
Value is
http/protobuf. -
Maximum length is
2048. -
Additional properties are allowed.
Hide retry_on_failure attributes Show retry_on_failure attributes object | null
-
Additional properties are allowed.
Hide sending_queue attributes Show sending_queue attributes object | null
-
Additional properties are allowed.
Hide batch attributes Show batch attributes object | null
-
Maximum length is
64. -
Additional properties are allowed.
-
Values are
itemsorbytes.
-
-
Values are
requests,items, orbytes.
-
-
Maximum length is
64. -
Additional properties are allowed.
Hide tls attributes Show tls attributes object | null
-
Maximum length is
4096. -
Maximum length is
65536. -
Maximum length is
4096. -
Maximum length is
65536. -
Not more than
100elements. Maximum length of each is256. -
Not more than
4elements. Values areX25519,P521,P256, orP384. -
Maximum length is
4096. -
Maximum length is
10. -
Maximum length is
10. -
Maximum length is
64. -
Maximum length is
256. -
Additional properties are allowed.
-
-
Maximum length is
2048.
-
-
Additional properties are allowed.
Hide secrets attribute Show secrets attribute object
-
Additional properties are allowed.
Hide otlp_exporter attribute Show otlp_exporter attribute object
-
-
Value is
otlp.
-
-
Bad Request
-
Not Found
curl \
--request GET 'https://<KIBANA_URL>/api/fleet/outputs/{outputId}' \
--header "Authorization: $API_KEY"
{
"item": {
"hosts": [
"https://elasticsearch.example.com:9200"
],
"id": "output-id-1",
"is_default": true,
"is_default_monitoring": true,
"name": "Default output",
"type": "elasticsearch"
}
}
{
"error": "Bad Request",
"message": "An error message describing what went wrong",
"statusCode": 400
}
{
"error": "Not Found",
"message": "Output output-id-1 not found",
"statusCode": 404
}