Command: operator api
The operator api
command allows easy access to Nomad's HTTP API similar to
the popular curl program. Nomad's operator api
command reads environment
variables to dramatically ease HTTP API access compared to trying to
manually write the same command with the third party curl
command.
For example for the following environment:
Accessing Nomad's /v1/jobs
HTTP endpoint with nomad operator
api
would require:
Performing the same request using the external curl
tool would require:
General Options
-address=<addr>
: The address of the Nomad server. Overrides theNOMAD_ADDR
environment variable if set. Defaults tohttp://127.0.0.1:4646
.-region=<region>
: The region of the Nomad server to forward commands to. Overrides theNOMAD_REGION
environment variable if set. Defaults to the Agent's local region.-namespace=<namespace>
: The target namespace for queries and actions bound to a namespace. Overrides theNOMAD_NAMESPACE
environment variable if set. If set to'*'
, subcommands which support this functionality query all namespaces authorized to user. Defaults to the "default" namespace.-no-color
: Disables colored command output. Alternatively,NOMAD_CLI_NO_COLOR
may be set. This option takes precedence over-force-color
.-force-color
: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,NOMAD_CLI_FORCE_COLOR
may be set. This option has no effect if-no-color
is also used.-ca-cert=<path>
: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides theNOMAD_CACERT
environment variable if set.-ca-path=<path>
: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both-ca-cert
and-ca-path
are specified,-ca-cert
is used. Overrides theNOMAD_CAPATH
environment variable if set.-client-cert=<path>
: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify-client-key
. Overrides theNOMAD_CLIENT_CERT
environment variable if set.-client-key=<path>
: Path to an unencrypted PEM encoded private key matching the client certificate from-client-cert
. Overrides theNOMAD_CLIENT_KEY
environment variable if set.-tls-server-name=<value>
: The server name to use as the SNI host when connecting via TLS. Overrides theNOMAD_TLS_SERVER_NAME
environment variable if set.-tls-skip-verify
: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped ifNOMAD_SKIP_VERIFY
is set.-token
: The SecretID of an ACL token to use to authenticate API requests with. Overrides theNOMAD_TOKEN
environment variable if set.
Operator API Options
-dryrun
: output a curl command instead of performing the HTTP request immediately. Note that you do not need the 3rd partycurl
command installed to useoperator api
. Thecurl
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.
Examples