Kibana synthetics API
Synthetics APIs enable you to check the status of your services and applications.
Kibana synthetics API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include synthetics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 18 operations across 9 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Kibana synthetics 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 18
Across 9 paths, the API surfaces 18 operations — 3 DELETE, 6 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Synthetics APIs enable you to check the status of your services and applications.
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Synthetics_commonMonitorFields (13 properties), Synthetics_postParameterResponse (6 properties), Synthetics_getPrivateLocation (6 properties), Synthetics_getParameterResponse (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kibana 12
Other APIs Kibana publishes across the network.