kibana/docs/api/synthetics/synthetics-api.asciidoc
Shahzad 29e8394c3d
[Synthetics] Monitor CRUD's public api's (#169928)
## Summary

Part of https://github.com/elastic/kibana/issues/169547

View docs at [Changed
pages](https://kibana_169928.docs-preview.app.elstc.co/diff)

Add monitor api public api 

### Testing

Make sure you have some monitors populated before testing this PR and
before switching to the branch

- [ ] Try editing already added monitors via API
- [ ] Test adding monitors via API, and then edit those via and
subsqeuently try editing via API the same monitor
- [ ] Test editing monitors via API
- [ ] Test deleting monitors via API
- [ ] Test getting monitors via API
- [ ] Testing private as well public locations

Basic workflow that i am interesting in testing is to make sure, you can
add/edit via both API and UI without any issues


Test each of HTTP/TCP/ICMP browser examples

<img width="1728" alt="image"
src="3575d93a-5f04-4c80-ac62-038643f466f8">

---------

Co-authored-by: Justin Kambic <jk@elastic.co>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Dominique Clarke <dominique.clarke@elastic.co>
2024-04-12 15:10:11 -04:00

42 lines
1.7 KiB
Text

[[synthetics-apis]]
== Synthetics APIs
The following APIs are available for Synthetics.
* <<add-monitor-api, Add monitor>> - Add a new monitor to Synthetics app.
* <<update-monitor-api, Update monitor>> - Update an existing monitor in Synthetics app.
* <<delete-monitors-api, Delete monitor>> - Delete an existing monitor from Synthetics app.
* <<get-monitor-api, Get monitor>> to get a monitor.
* <<find-monitors-api, Find monitors>> to find monitors.
* <<get-parameters-api, Get Parameters API>> to get a parameter(s).
* <<add-parameters-api, Create Parameter API>> to create a parameter.
* <<edit-parameter-by-id-api, Edit Parameter API>> to edit a parameter.
* <<delete-parameters-api, Delete Parameter API>> to delete a parameter.
* <<create-private-location-api, Create Private Location API>> to create a private location
* <<delete-private-location-api, Delete Private Location API>> to delete a private location
* <<get-private-locations-api, Get Private Locations API>> to get a list of private locations
include::monitors/add-monitor-api.asciidoc[leveloffset=+1]
include::monitors/update-monitor-api.asciidoc[leveloffset=+1]
include::monitors/delete-monitor-api.asciidoc[leveloffset=+1]
include::monitors/get-monitor-api.asciidoc[leveloffset=+1]
include::monitors/find-monitors-api.asciidoc[leveloffset=+1]
include::params/add-param.asciidoc[leveloffset=+1]
include::params/get-params.asciidoc[leveloffset=+1]
include::params/edit-param.asciidoc[leveloffset=+1]
include::params/delete-param.asciidoc[leveloffset=+1]
include::private-locations/create-private-location.asciidoc[leveloffset=+1]
include::private-locations/delete-private-location.asciidoc[leveloffset=+1]
include::private-locations/get-private-locations.asciidoc[leveloffset=+1]