doctl auth init [flags]
This command allows you to initialize doctl with a token that allows it to query and manage your account details and resources.
You will need an API token, which you can generate in the control panel at https://cloud.digitalocean.com/account/api/tokens.
You can provide a (case insensitive) name to this initialization via the --context
flag, and then it will be saved as an “authentication context”. Authentication contexts are accessible via doctl auth switch
, which re-initializes doctl, or by providing the --context
flag when using any doctl command (to specify that auth context for just one command). This enables you to use multiple DigitalOcean accounts with doctl, or tokens that have different authentication scopes.
If the --context
flag is not specified, a default authentication context will be created during initialization.
If doctl is never initialized, you will need to specify an API token whenever you use a doctl
command via the --access-token
flag.
Option | Description |
---|---|
--help
, -h
|
Help for this command |
--token-validation-server
|
The server used to validate a token
Default: https://cloud.digitalocean.com
|
Command | Description |
---|---|
doctl auth | Display commands for authenticating doctl with an account |
Option | Description |
---|---|
--access-token , -t
|
API V2 access token |
--api-url , -u
|
Override default API endpoint |
--config , -c
|
Specify a custom config file
Default:
|
--context
|
Specify a custom authentication context name |
--http-retry-max
|
Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5
|
--http-retry-wait-max
|
Set the minimum number of seconds to wait before retrying a failed request
Default: 30
|
--http-retry-wait-min
|
Set the maximum number of seconds to wait before retrying a failed request
Default: 1
|
--interactive
|
Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false
|
--output , -o
|
Desired output format [text|json]
Default: text
|
--trace
|
Show a log of network activity while performing a command
Default: false
|
--verbose , -v
|
Enable verbose output
Default: false
|