luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

docs: add op api options

Browse source
This commit is contained in:
Michael Schurter 2022-03-01 16:43:53 -08:00
parent cbf6ba843d
commit fcf4515875
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
website/content/docs/commands/operator/api.mdx
View file

@ -43,11 +43,29 @@ curl \
https://client.global.nomad:4646/v1/jobs
```
The `-dryrun` flag for `nomad operator api` will output a curl command instead
of performing the HTTP request immediately. Note that you do *not* need the 3rd
party `curl` command installed to use `operator api`. The `curl` output from
`-dryrun` is intended for use in scripts or running in locations without a
Nomad binary present.
## General Options
@include 'general_options.mdx'
## Operator API Options
- `-dryrun`: output a curl command instead of performing the HTTP request
immediately. Note that you do *not* need the 3rd party `curl` command
installed to use `operator api`. The `curl` output from `-dryrun` is intended
for use in scripts or running in locations without a Nomad binary present.
- `-filter`: Specifies an expression used to filter query results.
- `-H`: Adds an additional HTTP header to the request. May be specified more
than once. These headers take precedence over automatically set ones such as
X-Nomad-Token.
- `-verbose`: Output extra information to stderr similar to curl's --verbose
flag.
- `-X`: HTTP method of request. If there is data piped to stdin, then the
method defaults to POST. Otherwise the method defaults to GET.
[curl]: https://curl.se/
[envvars]: /docs/commands#environment-variables