Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

Added 'after' param to /carves endpoint. (#15061)

Browse Source 
API change for https://github.com/fleetdm/fleet/issues/14571
Reflects dev changes from PR https://github.com/fleetdm/fleet/pull/15047
This commit is contained in:
Victor Lyuboslavsky
2023-11-09 12:26:05 -06:00
committed by GitHub
parent 182ce615fb
commit fcafd0e5de
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST API/rest-api.md
+7 -6
View File
@@ -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