From fcafd0e5deefaba35d054c317dd02c8393636450 Mon Sep 17 00:00:00 2001 From: Victor Lyuboslavsky Date: Thu, 9 Nov 2023 12:26:05 -0600 Subject: [PATCH] Added 'after' param to /carves endpoint. (#15061) API change for https://github.com/fleetdm/fleet/issues/14571 Reflects dev changes from PR https://github.com/fleetdm/fleet/pull/15047 --- docs/REST API/rest-api.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/REST API/rest-api.md b/docs/REST API/rest-api.md index dda1c1f254..529e4580d5 100644 --- a/docs/REST API/rest-api.md +++ b/docs/REST API/rest-api.md @@ -642,13 +642,14 @@ Retrieves a list of the non expired carves. Carve contents remain available for #### Parameters -| Name | Type | In | Description | -|-----------------|---------|-------|-------------------------------------------------------------------------------------------------------------------------------| -| page | integer | query | Page number of the results to fetch. | -| per_page | integer | query | Results per page. | -| order_key | string | query | What to order results by. Can be any field listed in the `results` array example below. | +| Name | Type | In | Description | +|-----------------|---------|-------|--------------------------------------------------------------------------------------------------------------------------------| +| page | integer | query | Page number of the results to fetch. | +| per_page | integer | query | Results per page. | +| order_key | string | query | What to order results by. Can be any field listed in the `results` array example below. | | order_direction | string | query | **Requires `order_key`**. The direction of the order given the order key. Valid options are 'asc' or 'desc'. Default is 'asc'. | -| expired | boolean | query | Include expired carves (default: false) | +| after | string | query | The value to get results after. This needs `order_key` defined, as that's the column that would be used. | +| expired | boolean | query | Include expired carves (default: false) | #### Example