Skip to content

Commit 1383499

Browse files
[TFDN-1107] update docs for atlas agent sort (#777)
Adding documentation for a new sort by created-at feature in the agents list endpoint added here: hashicorp/atlas#24262
2 parents 764084d + e36b97e commit 1383499

File tree

1 file changed

+6
-5
lines changed
  • content/terraform-docs-common/docs/cloud-docs/api-docs

1 file changed

+6
-5
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/agents.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,11 +190,12 @@ curl \
190190

191191
This endpoint supports pagination [with standard URL query parameters](/terraform/cloud-docs/api-docs#query-parameters). Remember to percent-encode `[` as `%5B` and `]` as `%5D` if your tooling doesn't automatically encode URLs.
192192

193-
| Parameter | Description |
194-
| ------------------------- | ---------------------------------------------------------------------------- |
195-
| `filter[last-ping-since]` | **Optional.** Accepts a date in ISO8601 format (ex. `2020-08-11T10:41:23Z`). |
196-
| `page[number]` | **Optional.** If omitted, the endpoint will return the first page. |
197-
| `page[size]` | **Optional.** If omitted, the endpoint will return 20 agents per page. |
193+
| Parameter | Description |
194+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
195+
| `filter[last-ping-since]` | **Optional.** Accepts a date in ISO8601 format (ex. `2020-08-11T10:41:23Z`). |
196+
| `page[number]` | **Optional.** If omitted, the endpoint will return the first page. |
197+
| `page[size]` | **Optional.** If omitted, the endpoint will return 20 agents per page. |
198+
| `sort` | **Optional.** Allows sorting the returned agents. Valid value is `"created-at"`. Prepending a hyphen to the sort parameter will reverse the order (e.g. `"-created-at"`). |
198199

199200
### Sample Request
200201

0 commit comments

Comments
 (0)