LinuxCommandLibrary

doctl-account

Manage DigitalOcean account authentication

TLDR

Display account info

$ doctl account [[g|get]]
copy

Show the hourly API limit, progress towards it, and when the rate limit resets
$ doctl account [[rl|ratelimit]]
copy

Display help
$ doctl account [[-h|--help]]
copy

SYNOPSIS

doctl account get|rate-limit [--format text|json|yaml] [--no-header] [--access-token TOKEN] [--context-name NAME] [-h, --help]

PARAMETERS

--access-token string
    API token for authentication (overrides env var)

--context-name string
    Name of auth context to use

--format string
    Output format: text, json, or yaml (default text)

--no-header
    Suppress column headers in table output

-h, --help
    Show help for the command

DESCRIPTION

The doctl account subcommand is part of doctl, DigitalOcean's official command-line interface for interacting with their cloud platform.

It enables users to fetch critical account details, including the account UUID, email, droplet limit, and status, as well as API rate limit status. This is invaluable for automation scripts, CI/CD pipelines, and quick status checks without accessing the web dashboard.

Authentication requires a DigitalOcean API token, set via DO_API_TOKEN environment variable, --access-token flag, or saved contexts. Output supports human-readable tables, JSON, or YAML for easy parsing.

Primarily used by developers and sysadmins managing DigitalOcean resources programmatically.

CAVEATS

Requires valid DigitalOcean API token; read-only operations; rate-limited by API quotas.

EXAMPLES

doctl account get --format json
doctl account rate-limit

AUTHENTICATION

Set export DO_API_TOKEN=your-token or use doctl auth init.

HISTORY

Introduced with doctl v1.0 in 2017 by DigitalOcean; evolved with API v2 support and output formatting improvements in later releases.

SEE ALSO

doctl(1), curl(1)

Copied to clipboard