`query` API is missing from synthetic monitoring

grafana / synthetic-monitoring-app

Synthetic Monitoring frontend application

https://grafana.com/docs/grafana-cloud/how-do-i/synthetic-monitoring/

GNU Affero General Public License v3.0

130 stars 18 forks source link

`query` API is missing from synthetic monitoring #867

Closed peterschretlen closed 1 week ago

peterschretlen commented 3 months ago

What happened:

The client API docs mention this API:

GET /api/v1/check/query?job=:job:&target=:target:

But calling that API gives back a 400 with message:

{"msg":"invalid check ID accessing /api/v1/check/query","err":"invalid id \"query\""}

How to reproduce it (as minimally and precisely as possible):

get an API token from the config page
call curl -H "Authorization: Bearer <your-token-here>" https://<synthetics-backend-address-from-config-page>/api/v1/check/query

peterschretlen commented 3 months ago

I had a look and the code and tests for the cloud API exist. But the route is not there, will need to review the history and see if this was intentional or not. The fact that we have public docs suggest it may have been unintentionally removed.

d0ugal commented 1 month ago

The handler was removed here; https://github.com/grafana/synthetic-monitoring-api/commit/c85ed8ca0f7715cdf2ba3c3577fdb4a0661e31ad#diff-67daa38c612c4e37cdf6c61241ba2128dbf193398522071be4be5c7d7acbf256L87

It looks like the removal was accidental as there is no mention of it in the discussion. 8 /v1/check/* endpoints were deleted and 7 added.