You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: oas_docs/output/kibana.serverless.yaml
+46-4Lines changed: 46 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -75,25 +75,62 @@ tags:
75
75
x-displayName: Connectors
76
76
- name: Dashboards
77
77
- name: Data streams
78
+
description: |
79
+
Data stream APIs enable you to manage data streams, which are collections of indices that share the same index template and are managed as a single unit for time-series data.
80
+
x-displayName: Data streams
78
81
- description: Data view APIs enable you to manage data views, formerly known as Kibana index patterns.
79
82
name: data views
80
83
x-displayName: Data views
81
84
- name: Elastic Agent actions
85
+
description: |
86
+
Elastic Agent actions APIs enable you to manage actions performed on Elastic Agents, including agent reassignment, diagnostics collection, enrollment management, upgrades, and bulk operations for agent lifecycle management.
87
+
x-displayName: Elastic Agent actions
82
88
- name: Elastic Agent binary download sources
89
+
description: |
90
+
Elastic Agent binary download sources APIs enable you to manage download sources for Elastic Agent binaries, including creating, updating, and deleting custom download sources for agent binaries.
Elastic Agent policies APIs enable you to manage agent policies, including creating, updating, and deleting policies, as well as to retrieve agent policy outputs, manifests, and auto-upgrade status information.
95
+
x-displayName: Elastic Agent policies
84
96
- name: Elastic Agent status
97
+
description: |
98
+
Enables you to retrieve status information about Elastic Agents, including health summaries and operational status.
99
+
x-displayName: Elastic Agent status
85
100
- name: Elastic Agents
101
+
description: |
102
+
Elastic Agents APIs enable you to manage Elastic Agents, including retrieving agent information, managing agent lifecycle, handling file uploads, and initiating agent setup.
103
+
x-displayName: Elastic Agents
86
104
- name: Elastic Package Manager (EPM)
87
105
- name: Fleet enrollment API keys
106
+
description: |
107
+
Fleet enrollment API keys APIs enable you to manage enrollment API keys for Fleet, including creating, retrieving, and revoking API keys used for agent enrollment.
108
+
x-displayName: Fleet enrollment API keys
88
109
- name: Fleet internals
110
+
description: |
111
+
Fleet internals APIs enable you to manage Fleet internal operations, including checking permissions, monitoring Fleet Server health, managing settings, and initiating Fleet setup.
112
+
x-displayName: Fleet internals
89
113
- name: Fleet outputs
114
+
description: |
115
+
Fleet outputs APIs enable you to manage Fleet outputs, including creating, updating, and deleting output configurations, generating Logstash API keys, and monitoring output health.
116
+
x-displayName: Fleet outputs
90
117
- name: Fleet package policies
118
+
description: |
119
+
Fleet package policies APIs enable you to manage Fleet package policies, including creating, updating, and deleting policies, performing bulk operations, and managing policy upgrades.
120
+
x-displayName: Fleet package policies
91
121
- name: Fleet proxies
122
+
description: |
123
+
Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
124
+
x-displayName: Fleet proxies
92
125
- name: Fleet Server hosts
93
126
- name: Fleet service tokens
94
127
- name: Fleet uninstall tokens
95
128
- name: Message Signing Service
96
-
- description: Machine learning
129
+
description: |
130
+
Enables you to rotate message signing key pairs for secure Fleet communication.
131
+
x-displayName: Fleet Message Signing Service
132
+
- description: |
133
+
Enables you to synchronize machine learning saved objects.
97
134
name: ml
98
135
x-displayName: Machine learning
99
136
- name: roles
@@ -142,7 +179,8 @@ tags:
142
179
- description: Interact with and manage endpoints running the Elastic Defend integration.
143
180
name: Security Endpoint Management API
144
181
x-displayName: Security endpoint management
145
-
- description: ''
182
+
- description: |
183
+
Use the Security entity analytics APIs to manage entity analytics and risk scoring, including asset criticality, privileged user monitoring, and entity engines.
Streams is a new and experimental way to manage your data in Kibana. The API is currently not considered stable and can change at any point.
226
267
x-displayName: Streams
227
268
- name: system
228
269
x-displayName: System
229
270
description: |
230
-
Get information about the system status, resource usage, and installed plugins.
231
-
- externalDocs:
271
+
Get information about the system status, resource usage, features, and installed plugins.
272
+
- description: Task manager APIs enable you to check the health of the Kibana task manager, which is used by features such as alerting, actions, and reporting to run mission critical work as persistent background tasks.
Copy file name to clipboardExpand all lines: oas_docs/output/kibana.yaml
+60-5Lines changed: 60 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -89,23 +89,68 @@ tags:
89
89
x-displayName: Connectors
90
90
- name: Dashboards
91
91
- name: Data streams
92
+
description: |
93
+
Data stream APIs enable you to manage data streams, which are collections of indices that share the same index template and are managed as a single unit for time-series data.
94
+
x-displayName: Data streams
92
95
- description: Data view APIs enable you to manage data views, formerly known as Kibana index patterns.
93
96
name: data views
94
97
x-displayName: Data views
95
98
- name: Elastic Agent actions
99
+
description: |
100
+
Elastic Agent actions APIs enable you to manage actions performed on Elastic Agents, including agent reassignment, diagnostics collection, enrollment management, upgrades, and bulk operations for agent lifecycle management.
101
+
x-displayName: Elastic Agent actions
96
102
- name: Elastic Agent binary download sources
103
+
description: |
104
+
Elastic Agent binary download sources APIs enable you to manage download sources for Elastic Agent binaries, including creating, updating, and deleting custom download sources for agent binaries.
Elastic Agent policies APIs enable you to manage agent policies, including creating, updating, and deleting policies, as well as to retrieve agent policy outputs, manifests, and auto-upgrade status information.
109
+
x-displayName: Elastic Agent policies
98
110
- name: Elastic Agent status
111
+
description: |
112
+
Enables you to retrieve status information about Elastic Agents, including health summaries and operational status.
113
+
x-displayName: Elastic Agent status
99
114
- name: Elastic Agents
115
+
description: |
116
+
Elastic Agents APIs enable you to manage Elastic Agents, including retrieving agent information, managing agent lifecycle, handling file uploads, and initiating agent setup.
117
+
x-displayName: Elastic Agents
100
118
- name: Elastic Package Manager (EPM)
119
+
description: |
120
+
Elastic Package Manager (EPM) APIs enable you to manage packages and integrations, including installing, updating, and uninstalling packages, managing custom integrations, and handling package assets.
121
+
x-displayName: Elastic Package Manager (EPM)
101
122
- name: Fleet enrollment API keys
123
+
description: |
124
+
Fleet enrollment API keys APIs enable you to manage enrollment API keys for Fleet, including creating, retrieving, and revoking API keys used for agent enrollment.
125
+
x-displayName: Fleet enrollment API keys
102
126
- name: Fleet internals
127
+
description: |
128
+
Fleet internals APIs enable you to manage Fleet internal operations, including checking permissions, monitoring Fleet Server health, managing settings, and initiating Fleet setup.
129
+
x-displayName: Fleet internals
103
130
- name: Fleet outputs
131
+
description: |
132
+
Fleet outputs APIs enable you to manage Fleet outputs, including creating, updating, and deleting output configurations, generating Logstash API keys, and monitoring output health.
133
+
x-displayName: Fleet outputs
104
134
- name: Fleet package policies
135
+
description: |
136
+
Fleet package policies APIs enable you to manage Fleet package policies, including creating, updating, and deleting policies, performing bulk operations, and managing policy upgrades.
137
+
x-displayName: Fleet package policies
105
138
- name: Fleet proxies
139
+
description: |
140
+
Fleet proxies APIs enable you to manage Fleet proxies, including creating, updating, and deleting proxy configurations for Fleet agent communication.
141
+
x-displayName: Fleet proxies
106
142
- name: Fleet Server hosts
143
+
description: |
144
+
Fleet Server hosts APIs enable you to manage Fleet Server hosts, including creating, updating, and deleting Fleet Server host configurations.
145
+
x-displayName: Fleet Server hosts
107
146
- name: Fleet service tokens
147
+
description: |
148
+
Enables you to create tokens for Fleet service authentication and authorization.
149
+
x-displayName: Fleet service tokens
108
150
- name: Fleet uninstall tokens
151
+
description: |
152
+
Fleet uninstall tokens APIs enable you to manage Fleet uninstall tokens, including retrieving metadata and decrypted tokens for agent uninstallation.
153
+
x-displayName: Fleet uninstall tokens
109
154
- description: |
110
155
Programmatically integrate with Logstash configuration management.
111
156
> warn
@@ -116,7 +161,11 @@ tags:
116
161
name: logstash
117
162
x-displayName: Logstash configuration management
118
163
- name: Message Signing Service
119
-
- description: Machine learning
164
+
description: |
165
+
Enables you to rotate message signing key pairs for secure Fleet communication.
166
+
x-displayName: Fleet Message Signing Service
167
+
- description: |
168
+
Enables you to synchronize machine learning saved objects.
120
169
name: ml
121
170
x-displayName: Machine learning
122
171
- name: roles
@@ -135,7 +184,7 @@ tags:
135
184
* [Spaces](../group/endpoint-spaces)
136
185
* [Short URLs](../group/endpoint-short-url)
137
186
138
-
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions
187
+
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
139
188
name: saved objects
140
189
x-displayName: Saved objects
141
190
- description: Manage and interact with Security Assistant resources.
@@ -165,7 +214,8 @@ tags:
165
214
- description: Interact with and manage endpoints running the Elastic Defend integration.
166
215
name: Security Endpoint Management API
167
216
x-displayName: Security endpoint management
168
-
- description: ''
217
+
- description: |
218
+
Use the Security entity analytics APIs to manage entity analytics and risk scoring, including asset criticality, privileged user monitoring, and entity engines.
169
219
name: Security Entity Analytics API
170
220
x-displayName: Security entity analytics
171
221
- description: |
@@ -251,6 +301,7 @@ tags:
251
301
description: Space overview
252
302
- name: synthetics
253
303
x-displayName: Synthetics
304
+
description: Synthetics APIs enable you to check the status of your services and applications.
Get information about the system status, resource usage, features, and installed plugins.
263
314
name: system
264
315
x-displayName: System
265
-
- externalDocs:
316
+
- description: Task manager APIs enable you to check the health of the Kibana task manager, which is used by features such as alerting, actions, and reporting to run mission critical work as persistent background tasks.
0 commit comments