#14800 API design: POST request for "Run live query" endpoint by rachaelshaw · Pull Request #15508 · fleetdm/fleet

rachaelshaw · 2023-12-07T22:44:39Z

"Run live query" API updates based on @jrzmurray's PR #13002, to resolve issue #14800.

Since we have an existing endpoint (the one used by the Fleet UI) at POST /api/v1/fleet/queries/run, we aren't able to simply update the publicly-documented endpoint's method from GET to POST without a breaking change.

Instead, this proposes the following API changes:

New API endpoint: POST /api/v1/fleet/queries/:id/run. This becomes the publicly documented “Run live query” REST API endpoint. The differences are:
- POST HTTP method instead of GET.
- Targets 1 query at a time.
- Simpler response structure (since it targets a single query): no separate summary and live_query_results; the contents of both have been moved to the top level.
The existing “Run live query” endpoint is left intact for backwards compatibility, and linked to from the documentation section for the new endpoint.

Per Slack conversation https://osquery.slack.com/archives/C01DXJL16D8/p1690479355482889

…docs for new endpoint

rachaelshaw · 2023-12-08T18:39:44Z


 ### Run live query

+> This updated API endpoint replaced `GET /api/v1/fleet/queries/run` in Fleet 4.x.x, for improved compatibility with many HTTP clients. The [deprecated endpoint](https://github.com/fleetdm/fleet/blob/fleet-v4.41.1/docs/REST%20API/rest-api.md#run-live-query) is maintained for backwards compatibility.


TODO: replace 4.x.x with actual release version when this is scheduled into a sprint

Co-authored-by: Rachael Shaw <r@rachael.wtf>

noahtalerman · 2024-01-11T19:27:01Z

Marked this PR as ready for review because #14800 was shipped 🎉

Co-authored-by: Rachael Shaw <r@rachael.wtf>

jrzmurray and others added 3 commits July 27, 2023 15:02

Convert Run Live Queries endpoint from GET to POST

43db500

Per Slack conversation https://osquery.slack.com/archives/C01DXJL16D8/p1690479355482889

Merge branch 'main' into pr/13002

05618c6

Move old "Run live query" endpoint into API for contributors and add …

995f77b

…docs for new endpoint

fleet-release approved these changes Dec 7, 2023

View reviewed changes

rachaelshaw temporarily deployed to Docker Hub December 7, 2023 22:44 — with GitHub Actions Inactive

fleet-release previously approved these changes Dec 7, 2023

View reviewed changes

rachaelshaw commented Dec 7, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

rachaelshaw dismissed fleet-release’s stale review via 682aafc December 7, 2023 23:00

Update docs/REST API/rest-api.md

682aafc

fleet-release previously approved these changes Dec 7, 2023

View reviewed changes

rachaelshaw had a problem deploying to Docker Hub December 7, 2023 23:00 — with GitHub Actions Error

rachaelshaw commented Dec 7, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

rachaelshaw commented Dec 7, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

rachaelshaw dismissed fleet-release’s stale review via fec34ec December 7, 2023 23:02

Update docs/REST API/rest-api.md

fec34ec

fleet-release previously approved these changes Dec 7, 2023

View reviewed changes

rachaelshaw temporarily deployed to Docker Hub December 7, 2023 23:02 — with GitHub Actions Inactive

rachaelshaw commented Dec 8, 2023

View reviewed changes

Comment thread docs/Contributing/API-for-contributors.md Outdated

rachaelshaw commented Dec 8, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

Update docs/REST API/rest-api.md

fae3554

rachaelshaw dismissed fleet-release’s stale review via fae3554 December 8, 2023 18:39

fleet-release previously approved these changes Dec 8, 2023

View reviewed changes

rachaelshaw had a problem deploying to Docker Hub December 8, 2023 18:39 — with GitHub Actions Error

rachaelshaw commented Dec 8, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

Update docs/REST API/rest-api.md

8609ef5

rachaelshaw dismissed fleet-release’s stale review via 8609ef5 December 8, 2023 18:41

fleet-release previously approved these changes Dec 8, 2023

View reviewed changes

rachaelshaw temporarily deployed to Docker Hub December 8, 2023 18:41 — with GitHub Actions Inactive

rachaelshaw commented Dec 8, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

fleet-release previously approved these changes Dec 15, 2023

View reviewed changes

Update new run live query endpoint to be for 1 host

1eac2a0

rachaelshaw dismissed fleet-release’s stale review via 1eac2a0 December 15, 2023 23:50

fleet-release approved these changes Dec 15, 2023

View reviewed changes

rachaelshaw temporarily deployed to Docker Hub December 15, 2023 23:50 — with GitHub Actions Inactive

fleet-release previously approved these changes Dec 15, 2023

View reviewed changes

rachaelshaw mentioned this pull request Dec 15, 2023

Host details > Queries: Report updated "Never" tooltip doesn't take live queries into account #15707

Closed

Update rest-api.md

cad1bb7

rachaelshaw dismissed fleet-release’s stale review via cad1bb7 December 18, 2023 23:53

fleet-release approved these changes Dec 18, 2023

View reviewed changes

rachaelshaw temporarily deployed to Docker Hub December 18, 2023 23:53 — with GitHub Actions Inactive

fleet-release previously approved these changes Dec 18, 2023

View reviewed changes

rachaelshaw commented Dec 19, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

rachaelshaw commented Dec 19, 2023

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

noahtalerman dismissed fleet-release’s stale review via ae5fec8 January 11, 2024 19:24

Update docs/REST API/rest-api.md

ae5fec8

Co-authored-by: Rachael Shaw <r@rachael.wtf>

noahtalerman had a problem deploying to Docker Hub January 11, 2024 19:24 — with GitHub Actions Error

noahtalerman reviewed Jan 11, 2024

View reviewed changes

Comment thread docs/REST API/rest-api.md Outdated

Update docs/REST API/rest-api.md

6669ff2

noahtalerman marked this pull request as ready for review January 11, 2024 19:26

noahtalerman had a problem deploying to Docker Hub January 11, 2024 19:26 — with GitHub Actions Error

Merge branch 'main' into 14800-live-query-api

178fd9d

noahtalerman had a problem deploying to Docker Hub January 11, 2024 19:26 — with GitHub Actions Error

noahtalerman requested a review from fleet-release January 11, 2024 19:27

Update docs/REST API/rest-api.md

656d075

Co-authored-by: Rachael Shaw <r@rachael.wtf>

noahtalerman temporarily deployed to Docker Hub January 11, 2024 19:27 — with GitHub Actions Inactive

noahtalerman approved these changes Jan 11, 2024

View reviewed changes

noahtalerman merged commit 7c84588 into main Jan 11, 2024

noahtalerman deleted the 14800-live-query-api branch January 11, 2024 19:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#14800 API design: POST request for "Run live query" endpoint#15508

#14800 API design: POST request for "Run live query" endpoint#15508
noahtalerman merged 18 commits intomainfrom
14800-live-query-api

rachaelshaw commented Dec 7, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rachaelshaw Dec 8, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

noahtalerman commented Jan 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		### Run live query

		> This updated API endpoint replaced `GET /api/v1/fleet/queries/run` in Fleet 4.x.x, for improved compatibility with many HTTP clients. The [deprecated endpoint](https://github.com/fleetdm/fleet/blob/fleet-v4.41.1/docs/REST%20API/rest-api.md#run-live-query) is maintained for backwards compatibility.

Conversation

rachaelshaw commented Dec 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rachaelshaw Dec 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

noahtalerman commented Jan 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rachaelshaw commented Dec 7, 2023 •

edited

Loading

rachaelshaw Dec 8, 2023 •

edited

Loading