Authentication
In Cloudflare’s system, a user can have multiple accounts and zones. As a result, your user is configured globally on your machine via a single Cloudflare Token. Your account(s) and zone(s) will be configured per project, but will use your Cloudflare Token to authenticate all API calls. A configuration file is created in a .wrangler
directory in your computer’s home directory.
To set up Wrangler to work with your Cloudflare user, use the following commands:
login
: a command that opens a Cloudflare account login page to authorize Wrangler.config
: an alternative tologin
that prompts you to enter youremail
andapi
key.whoami
: run this command to confirm that your configuration is appropriately set up. When successful, this command will print out your account email and youraccount_id
needed for your project'swrangler.toml
file.
You can also configure your global user with environment variables. This is the preferred method for using Wrangler in CI (continuous integration) environments.
To customize the authentication tokens that Wrangler uses, you may provide the CF_ACCOUNT_ID
and CF_API_TOKEN
environment variables when running any Wrangler command. The account ID may be obtained from the Cloudflare dashboard in Overview and you may create or reuse an existing API token.
Alternatively, you may use the CF_EMAIL
and CF_API_KEY
environment variable combination instead:
You can also specify or override the target Zone ID by defining the CF_ZONE_ID
environment variable.
Defining environment variables inline will override the default credentials stored in wrangler config
or in your wrangler.toml
file.
- In Overview, select Get your API token.
- After being taken to the Profile page, select Create token.
- Under the API token templates section, find the Edit Cloudflare Workers template and select Use template.
- Fill out the rest of the fields and then select Continue to summary, where you can select Create Token and issue your token for use.
- In Overview, select Get your API token.
- After being taken to the Profile page, scroll to API Keys.
- Select View to copy your Global API Key.*
After getting your token or key, you can set up your default credentials on your local machine by running wrangler config
:
Use the --api-key
flag to instead configure with email and global API key: