Elastic Stack

Elastic Stack (ELK Stack) Synthetics API

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

GitHub OpenAPI
Business capability
Observability Management BC-4220.20

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/synthetics/monitor/test/{monitorId} Run an on-demand test of a monitor · Trigger an on-demand test run for a monitor #
Ask an LLM
“Can I trigger a synthetic monitor to run right now instead of waiting for its schedule?”
“How do I get a test run ID back after kicking off an immediate monitor check?”
Tell an agent
Run an on-demand test of monitor {monitorId}.
Trigger an immediate check for synthetic monitor {monitorId} now.
GET /api/synthetics/monitors List synthetic monitors · Get monitors #
Ask an LLM
“Which uptime and synthetic monitors do I have configured?”
“Can I filter my monitors by location, type or tag?”
Tell an agent
List my synthetic monitors of type {monitorTypes}.
Show monitors tagged {tags} running from {locations}.
POST /api/synthetics/monitors Create a synthetic monitor · Create a monitor #
Ask an LLM
“How do I set up a new HTTP uptime check for my site?”
“Can I create browser, TCP or ICMP monitors through the Synthetics API?”
Tell an agent
Create a new HTTP monitor for my homepage.
Add a browser synthetic monitor with the attributes I give you.
POST /api/synthetics/monitors/_bulk_delete Delete several monitors at once · Delete monitors #
Ask an LLM
“How do I remove a batch of synthetic monitors in one request?”
“Can I bulk delete monitors by their config IDs?”
Tell an agent destructive · confirm first
Bulk delete monitors {ids}.
Remove all of these synthetic monitor configs: {ids}.
DELETE /api/synthetics/monitors/{id} Delete a synthetic monitor · Delete a monitor #
Ask an LLM
“How do I remove a single monitor from the Synthetics app?”
“What privileges do I need to delete one monitor?”
Tell an agent destructive · confirm first
Delete synthetic monitor {id}.
Remove monitor {id} from Synthetics.
GET /api/synthetics/monitors/{id} Get a synthetic monitor · Get a monitor #
Ask an LLM
“How do I view the full configuration of a single monitor?”
“What schedule and locations is one particular monitor using?”
Tell an agent
Get synthetic monitor {id}.
Show the settings for monitor {id}.
PUT /api/synthetics/monitors/{id} Update a synthetic monitor · Update a monitor #
Ask an LLM
“Can I change just one field of a monitor, like its schedule, without resending everything?”
“How do I edit an existing synthetic monitor's attributes?”
Tell an agent
Update monitor {id} with the new attributes.
Partially edit synthetic monitor {id}, changing only the fields I list.
GET /api/synthetics/params List Synthetics parameters · Get parameters #
Ask an LLM
“What global parameters are defined for my synthetic monitors?”
“Where do I see all the reusable Synthetics params in this space?”
Tell an agent
List all Synthetics parameters.
Show every global param my monitors can reference.
POST /api/synthetics/params Add Synthetics parameters · Add parameters #
Ask an LLM
“How do I add reusable variables that my synthetic monitors can reference?”
“Can I create several Synthetics parameters in one request?”
Tell an agent
Add a new Synthetics parameter for my monitors.
Create these global params in the Synthetics app.
POST /api/synthetics/params/_bulk_delete Delete several Synthetics parameters · Delete parameters #
Ask an LLM
“Can I delete multiple Synthetics parameters at once?”
“How do I bulk remove params my monitors no longer use?”
Tell an agent destructive · confirm first
Bulk delete Synthetics parameters {ids}.
Remove the params with IDs {ids}.
DELETE /api/synthetics/params/{id} Delete a Synthetics parameter · Delete a parameter #
Ask an LLM
“How do I delete a single Synthetics parameter?”
“Can I remove one param from the Synthetics app by ID?”
Tell an agent destructive · confirm first
Delete Synthetics parameter {id}.
Remove param {id}.
GET /api/synthetics/params/{id} Get a Synthetics parameter · Get a parameter #
Ask an LLM
“How do I look up a single Synthetics parameter by ID?”
“What's the key and value of one specific monitor param?”
Tell an agent
Get Synthetics parameter {id}.
Show the details of param {id}.
PUT /api/synthetics/params/{id} Update a Synthetics parameter · Update a parameter #
Ask an LLM
“How do I change the value of a Synthetics parameter?”
“Can I rename a param's key or retag it?”
Tell an agent
Set the value of Synthetics parameter {id} to {value}.
Update param {id} with key {key} and tags {tags}.
GET /api/synthetics/private_locations List private locations · Get private locations #
Ask an LLM
“Which private locations can I run synthetic monitors from?”
“What self-hosted monitoring locations are set up?”
Tell an agent
List my private locations.
Show all self-hosted Synthetics locations.
POST /api/synthetics/private_locations Create a private location · Create a private location #
Ask an LLM
“How do I run monitors from inside my own network using a private location?”
“Which agent policy does a new private location need?”
Tell an agent
Create private location {label} using agent policy {agentPolicyId}.
Add private location {label} on policy {agentPolicyId} at coordinates {geo}.
DELETE /api/synthetics/private_locations/{id} Delete a private location · Delete a private location #
Ask an LLM
“How do I remove a private location I no longer run monitors from?”
“Can I delete a self-hosted Synthetics location?”
Tell an agent destructive · confirm first
Delete private location {id}.
Remove the self-hosted location {id}.
GET /api/synthetics/private_locations/{id} Get a private location · Get a private location #
Ask an LLM
“How do I see the details of one private location?”
“Which agent policy backs a specific private location?”
Tell an agent
Get private location {id}.
Show the configuration of private location {id}.
PUT /api/synthetics/private_locations/{id} Rename a private location · Update a private location #
Ask an LLM
“Can I change the label of an existing private location?”
“What can I update on a private location after it's created?”
Tell an agent
Rename private location {id} to {label}.
Set the label of location {id} to {label}.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-synthetics-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-synthetics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-synthetics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    name: Kibana Team
  description: The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
  title: Kibana Synthetics API
  version: ''
  x-doc-license:
    name: Attribution-NonCommercial-NoDerivatives 4.0 International
    url: https://creativecommons.org/licenses/by-nc-nd/4.0/
  x-feedbackLink:
    label: Feedback
    url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
  variables:
    kibana_url:
      default: localhost:5601
security:
- apiKeyAuth: []
- basicAuth: []
tags:


# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-synthetics-api-openapi.yml