How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 1.0.

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

18 operations 9 paths 10 schemas 3 DELETE6 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

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 18

Synthetics APIs enable you to check the status of your services and applications.

POST
/api/synthetics/monitor/test/{monitorId}
Trigger an on-demand test run for a monitor
post-synthetics-monitor-test 1 param → 200404
GET
/api/synthetics/monitors
Get monitors
get-synthetic-monitors 13 params → 200
POST
/api/synthetics/monitors
Create a monitor
post-synthetic-monitors body → 200400
POST
/api/synthetics/monitors/_bulk_delete
Delete monitors
delete-synthetic-monitors body → 200
DELETE
/api/synthetics/monitors/{id}
Delete a monitor
delete-synthetic-monitor 1 param → 200
GET
/api/synthetics/monitors/{id}
Get a monitor
get-synthetic-monitor 1 param → 200404
PUT
/api/synthetics/monitors/{id}
Update a monitor
put-synthetic-monitor 1 param body → 200400
GET
/api/synthetics/params
Get parameters
get-parameters → 200
POST
/api/synthetics/params
Add parameters
post-parameters body → 200
POST
/api/synthetics/params/_bulk_delete
Delete parameters
delete-parameters body → 200
DELETE
/api/synthetics/params/{id}
Delete a parameter
delete-parameter 1 param → 200
GET
/api/synthetics/params/{id}
Get a parameter
get-parameter 1 param → 200
PUT
/api/synthetics/params/{id}
Update a parameter
put-parameter 1 param body → 200
GET
/api/synthetics/private_locations
Get private locations
get-private-locations → 200
POST
/api/synthetics/private_locations
Create a private location
post-private-location body → 200400
DELETE
/api/synthetics/private_locations/{id}
Delete a private location
delete-private-location 1 param → 200
GET
/api/synthetics/private_locations/{id}
Get a private location
get-private-location 1 param → 200
PUT
/api/synthetics/private_locations/{id}
Update a private location
put-private-location 1 param body → 200400404

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.

Synthetics_commonMonitorFields
object
13 properties 1 required
Synthetics_tcpMonitorFields
Synthetics_browserMonitorFields
Synthetics_parameterRequest
object
5 properties 2 required
Synthetics_getParameterResponse
object
6 properties
Synthetics_icmpMonitorFields
Synthetics_getPrivateLocation
object
6 properties
Synthetics_httpMonitorFields
Synthetics_postParameterResponse
object
6 properties
Synthetics_monitorWarning
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-synthetics-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
Where this information came from

This is an independent, third-party profile of Kibana synthetics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.