Kibana ml API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ml. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
3 operations
across 3 paths,
and defines 9 schemas.
It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
3 operations3 paths9 schemas1 GET2 POST
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 ml 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 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
ml 3
Enables you to synchronize machine learning saved objects.
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Machine_learning_APIs_mlSync200Response (4 properties), Machine_learning_APIs_mlSyncResponseSavedObjectsCreated (3 properties), Machine_learning_APIs_mlSync4xxResponse (3 properties), Machine_learning_APIs_mlSyncResponseSavedObjectsDeleted (3 properties). Each schema is shown below with its type and property counts.
Machine_learning_APIs_mlSyncResponseSuccess
boolean
The success or failure of the synchronization.
Machine_learning_APIs_mlSync200Response
object
4 properties
Machine_learning_APIs_mlSync4xxResponse
object
3 properties
Machine_learning_APIs_mlSyncResponseTrainedModels
object
The sync machine learning saved objects API response contains this object when there are trained models affected by the synchronization. There is an object for…
The sync machine learning saved objects API response contains this object when there are data frame analytics jobs affected by the synchronization. There is an…
1 property
Machine_learning_APIs_mlSyncResponseDatafeeds
object
The sync machine learning saved objects API response contains this object when there are datafeeds affected by the synchronization. There is an object for each…
The sync machine learning saved objects API response contains this object when there are anomaly detection jobs affected by the synchronization. There is an ob…
If saved objects exist for machine learning jobs or trained models that no longer exist, they are deleted when you run the sync machine learning saved objects…
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
