aioflare

Global API Key

Legacy authentication method (less secure but simpler)

Security Warning

Global API Key provides full access to your Cloudflare account. Use API Token instead for better security.

How to Get Global API Key

  1. Go to your Cloudflare profile pagehere
  2. Scroll down to the "API Keys" section
  3. Click "View" next to "Global API Key"
  4. Enter your Cloudflare password to reveal the key
Example format:
β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’β€’

API Token (Recommended)

More secure authentication method with granular permissions

Recommended

API Token is more secure because it only grants specific permissions you choose, not full account access.

How to Create API Token

  1. Go to your Cloudflare API Tokens pagehere
  2. Click "Create Token" button
  3. Use "Edit zone DNS" template as a starting point
  4. Add the required permissions listed below
  5. Click "Continue to summary" then "Create Token"

Required Permissions

Add these permissions to your API Token for full aioflare functionality

Zone - DNS - Edit

Required for adding, editing, and deleting DNS records

β€’ Permission: Zone

β€’ Resource: DNS

β€’ Access: Edit β†’ Zone Resources: All zones

Zone - Zone - Edit

Required for adding and removing domains/zones

β€’ Permission: Zone

β€’ Resource: Zone

β€’ Access: Edit β†’ Zone Resources: All zones

Zone - Zone Settings - Edit

Required for development mode toggle and page rules (for redirect)(Includes: development mode, page rules for redirect)

β€’ Permission: Zone

β€’ Resource: Zone Settings

β€’ Access: Edit β†’ Zone Resources: All zones

Zone - Cache Purge - Edit

Required for purging cached content from Cloudflare CDN

β€’ Permission: Zone

β€’ Resource: Cache Purge

β€’ Access: Purge β†’ Zone Resources: All zones

Zone - Bot Management - Edit

Required for enabling/disabling Bot Fight Mode and bot protection settings

β€’ Permission: Zone

β€’ Resource: Bot Management

β€’ Access: Edit β†’ Zone Resources: All zones

Zone - Analytics - Read

Required for viewing zone analytics data and traffic statisticsNote: This permission may not be available on all Cloudflare accounts

β€’ Permission: Zone

β€’ Resource: Analytics

β€’ Access: Read β†’ Zone Resources: All zones

Account - Account Settings - Read

Required for reading account information and API usage

β€’ Permission: Account

β€’ Resource: Account Settings

β€’ Access: Read β†’ Account Resources: Include β†’ Select your account