Cloudflare API Documentation

archived 1 Oct 2023 03:52:23 UTC
logo

Cloudflare API

Overview
Endpoints
API Shield Client Certificates for a Zone
API Shield Endpoint Management
API Shield Settings
ASN Intelligence
Access Bookmark applications (Deprecated)
Access applications
Access authentication logs
Access custom pages
Access groups
Access identity providers
Access key configuration
Access mTLS authentication
Access policies
Access service tokens
Access short-lived certificate CAs
Access tags
Account Billing Profile
Account Load Balancer Monitors
Account Load Balancer Pools
Account Load Balancer Search
Account Members
Account Railguns
Account Request Tracer
Account Roles
Account Rulesets
Account Subscriptions
Account-Level Custom Nameservers
Account-Level Custom Nameservers Usage for a Zone
Accounts
Analyze Certificate
Argo Analytics for Geolocation
Argo Analytics for Zone
Argo Smart Routing
Argo Tunnel
Audit Logs
Available Page Rules settings
Bot Settings
Certificate Packs
Client
Cloudflare IPs
Cloudflare Images
Cloudflare Images Keys
Cloudflare Images Variants
Cloudflare Tunnel
Cloudflare Tunnel configuration
Custom Hostname Fallback Origin for a Zone
Custom Hostname for a Zone
Custom Indicator Feeds
Custom SSL for a Zone
Custom pages for a zone
Custom pages for an account
D1
DCV Delegation
DEX Synthetic Application Montitoring
DLP Pattern Validation
DLP Payload Log Settings
DLP Profiles
DNS Analytics
DNS Firewall
DNS Firewall Analytics
DNS Records for a Zone
DNSSEC
Device DEX Tests
Device Managed Networks
Device Posture Integrations
Device posture rules
Devices
Diagnostics
Domain History
Domain Intelligence
Durable Objects Namespace
Email Routing destination addresses
Email Routing routing rules
Email Routing settings
Filters
Firewall rules
Health Checks
Hyperdrive
IP Access rules for a user
IP Access rules for a zone
IP Access rules for an account
IP Address Management Address Maps
IP Address Management BGP Prefixes
IP Address Management Dynamic Advertisement
IP Address Management Prefix Delegation
IP Address Management Prefixes
IP Address Management Service Bindings
IP Intelligence
IP List
Instant Logs jobs for a zone
Keyless SSL for a Zone
Lists
Load Balancer Healthcheck Events
Load Balancer Monitors
Load Balancer Pools
Load Balancer Regions
Load Balancers
Logcontrol CMB config for an account
Logpush jobs for a zone
Logpush jobs for an account
Logs Received
Magic GRE tunnels
Magic IPsec tunnels
Magic Interconnects
Magic Network Monitoring Configuration
Magic Network Monitoring Rules
Magic PCAP collection
Magic Static Routes
Managed Transforms
Miscategorization
Notification Alert Types
Notification History
Notification Mechanism Eligibility
Notification destinations with PagerDuty
Notification policies
Notification webhooks
Observatory
Organization Invites
Organization Members
Organization Railgun
Organization Roles
Organizations (Deprecated)
Origin CA
Origin Post-Quantum
Page Rules
Page Shield
Pages Build Cache
Pages Deployment
Pages Domains
Pages Project
Passive DNS by IP
Per-Hostname TLS Settings
Per-hostname Authenticated Origin Pull
Permission Groups
Phishing URL Information
Phishing URL Scanner
Queue
R2 Bucket
Radar AS112
Radar Annotations
Radar Attacks
Radar BGP
Radar Connection Tampering
Radar DNS
Radar Datasets
Radar Email Security
Radar Entities
Radar Http
Radar Netflows
Radar Quality
Radar Ranking
Radar Search
Radar Traffic Anomalies
Radar Verified Bots
Railgun
Railgun Connections
Railgun Connections for a Zone
Rate limits for a zone
Registrar Domains
SSL Verification
SSL/TLS Mode Recommendation
Secondary DNS (ACL)
Secondary DNS (Peer)
Secondary DNS (Primary Zone)
Secondary DNS (Secondary Zone)
Secondary DNS (TSIG)
Smart Tiered Cache
Spectrum Aggregate Analytics
Spectrum Analytics (By Time)
Spectrum Analytics (Summary)
Spectrum Applications
Stream Add Audio Tracks
Stream Live Inputs
Stream MP4 Downloads
Stream Signing Keys
Stream Subtitles/Captions
Stream Video Clipping
Stream Videos
Stream Watermark Profile
Stream Webhook
Tiered Caching
Total TLS
Tunnel Virtual Network
Tunnel route
Turnstile
URL Normalization
URL Scanner
Universal SSL Settings for a Zone
User
User API Tokens
User Agent Blocking rules
User Billing History
User Billing Profile
User Subscription
User's Account Memberships
User's Invites
User's Organizations
VectorizeIndex
WAF overrides
WAF packages
WAF rule groups
WAF rules
WHOIS Record
Waiting Room
Web Analytics
Web3 Hostname
Worker Account Settings
Worker Binding (Deprecated)
Worker Cron Trigger
Worker Deployments
Worker Domain
Worker Environment
Worker Filters (Deprecated)
Worker Routes
Worker Script
Worker Script (Deprecated)
Worker Subdomain
Worker Tail Logs
Workers AI
Workers KV Namespace
Workers KV Request Analytics
Workers KV Stored Data Analytics
Workers for Platforms
Zero Trust Gateway application and application type mappings
Zero Trust Gateway categories
Zero Trust Gateway locations
Zero Trust Gateway proxy endpoints
Zero Trust Gateway rules
Zero Trust accounts
Zero Trust lists
Zero Trust organization
Zero Trust seats
Zero Trust users
Zone
Zone Analytics (Deprecated)
Zone Cache Settings
Zone Holds
Zone Lockdown
Zone Rate Plan
Zone Rulesets
Zone Settings
Zone Snippets
Zone Subscription
Zone-Level Access applications
Zone-Level Access groups
Zone-Level Access identity providers
Zone-Level Access mTLS authentication
Zone-Level Access policies
Zone-Level Access service tokens
Zone-Level Access short-lived certificate CAs
Zone-Level Authenticated Origin Pulls
Zone-Level Zero Trust organization
mTLS Certificate Management
powered by Stoplight

Cloudflare API

v4.0.0
API Base URL
Client API:https://api.cloudflare.com/client/v4
Security
API Key (api_email)
An API key is a token that you provide when making API calls. Include the token in a header parameter called X-Auth-Email.
Example: X-Auth-Email: 123
Additional Information
Interact with Cloudflare's products and services via the Cloudflare API.
Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.
To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to our API fundamentals.
Totally new to Cloudflare? Start here.
0%
10%
20%
30%
40%
50%
60%
70%
80%
90%
100%