diff --git a/website/content/api-docs/nodes.mdx b/website/content/api-docs/nodes.mdx index c08739e819b2..3eac73a90a09 100644 --- a/website/content/api-docs/nodes.mdx +++ b/website/content/api-docs/nodes.mdx @@ -31,6 +31,20 @@ The table below shows this endpoint's support for number of hexadecimal characters (0-9a-f). This is specified as a query string parameter. +- `next_token` `(string: "")` - This endpoint supports paging. The `next_token` + parameter accepts a string which identifies the next expected node. This + value can be obtained from the `X-Nomad-NextToken` header from the previous + response. + +- `per_page` `(int: 0)` - Specifies a maximum number of nodes to return for + this request. If omitted, the response is not paginated. The value of the + `X-Nomad-NextToken` header of the last response can be used as the + `next_token` of the next request to fetch additional pages. + +- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering) + used to filter the results. Consider using pagination or a query parameter to + reduce resource used to serve the request. + - `resources` `(bool: false)` - Specifies whether or not to include the `NodeResources` and `ReservedResources` fields in the response. diff --git a/website/content/docs/commands/node/status.mdx b/website/content/docs/commands/node/status.mdx index c1a2df0c63fe..2a7075d8c48d 100644 --- a/website/content/docs/commands/node/status.mdx +++ b/website/content/docs/commands/node/status.mdx @@ -47,6 +47,12 @@ capability. - `-verbose`: Show full information. +- `-per-page`: How many results to show per page. + +- `-page-token`: Where to start pagination. + +- `-filter`: Specifies an expression used to filter query results. + - `-os`: Display operating system name. - `-quiet`: Display only node IDs.