Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
小 白蛋
Nomad
Commits
ed95316b
Commit
ed95316b
authored
3 years ago
by
Michael Schurter
Browse files
Options
Download
Email Patches
Plain Diff
docs: add op api options
parent
3b49cde5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
website/content/docs/commands/operator/api.mdx
+23
-5
website/content/docs/commands/operator/api.mdx
with
23 additions
and
5 deletions
+23
-5
website/content/docs/commands/operator/api.mdx
+
23
-
5
View file @
ed95316b
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment