Cloudflare

Cloudflare User API

The User API from Cloudflare — 28 operation(s) for user.

GitHub OpenAPI

Operations 47

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /user Get my user profile details · Cloudflare User Details #
Ask an LLM
“What personal details does my Cloudflare user profile hold?”
“Can I see the name and contact details on my own user account?”
Tell an agent
Show my user profile details.
Fetch the details of the user I'm signed in as.
PATCH /user Edit my user profile · Cloudflare Edit User #
Ask an LLM
“How do I change the name on my user profile?”
“Can I update the telephone number and zipcode stored on my user account?”
Tell an agent
Change my profile name to {first_name} {last_name}.
Update my profile telephone number to {telephone}.
GET /user/audit_logs List audit logs for my user account · Cloudflare Get user audit logs #
Ask an LLM
“Who changed settings on my account, and when?”
“Can I filter my user audit logs by the email of the person who made the change?”
Tell an agent
Show my user audit logs since {since}.
List audit log entries made by {actor_email} on zone {zone_name}.
GET /user/billing/history View my billing history · Cloudflare Billing History Details #
Ask an LLM
“Where can I see my past charges and billing history?”
“Can I filter my billing history by the type of transaction?”
Tell an agent
Show my billing history.
List billing history entries of type {type}.
GET /user/billing/profile View my billing profile · Cloudflare Billing Profile Details #
Ask an LLM
“What billing profile and payment details are on file for my user?”
“Can I check which billing address my user account uses?”
Tell an agent
Show my billing profile.
Get the billing profile attached to my user account.
GET /user/firewall/access_rules/rules List my user-level IP Access rules · Cloudflare List IP Access rules #
Ask an LLM
“Which IP addresses have I blocked or allowed across all my zones?”
“Can I sort my user-level IP Access rules by mode or configuration?”
Tell an agent
List my user-level IP Access rules.
Show page {page} of my IP Access rules, {per_page} per page.
POST /user/firewall/access_rules/rules Create an IP Access rule for all my zones · Cloudflare Create an IP Access rule #
Ask an LLM
“How do I block an IP address across every zone I own?”
“Can I challenge a whole country or ASN on all my zones with one rule?”
Tell an agent
Create a user-level IP Access rule to {mode} the target {configuration}.
Add an IP Access rule that applies {mode} to {configuration} on all my zones, with the note {notes}.
DELETE /user/firewall/access_rules/rules/{identifier} Delete a user-level IP Access rule · Cloudflare Delete an IP Access rule #
Ask an LLM
“How do I remove an IP block that applies to all my zones?”
“What happens to my zones when I delete a user-level IP Access rule?”
Tell an agent destructive · confirm first
Delete IP Access rule {identifier} from my user account.
Remove the user-level IP Access rule {identifier}.
PATCH /user/firewall/access_rules/rules/{identifier} Change an IP Access rule's action or notes · Cloudflare Update an IP Access rule #
Ask an LLM
“Can I switch an existing IP Access rule from block to challenge?”
“Which parts of a user-level IP Access rule can I edit after creating it?”
Tell an agent
Change the action of IP Access rule {identifier} to {mode}.
Update the notes on IP Access rule {identifier} to {notes}.
GET /user/invites List my pending invitations · Cloudflare List Invitations #
Ask an LLM
“Have I been invited to join any accounts?”
“Where can I see all the invitations sent to my user?”
Tell an agent
List all invitations sent to me.
Show my account invitations.
GET /user/invites/{invite_id} Get details of one invitation · Cloudflare Invitation Details #
Ask an LLM
“Who sent a particular invitation and which account is it for?”
“Can I check the status of a single invite before I accept it?”
Tell an agent
Show the details of invitation {invite_id}.
Look up invite {invite_id} and tell me who it's from.
PATCH /user/invites/{invite_id} Accept or reject an invitation · Cloudflare Respond to Invitation #
Ask an LLM
“How do I accept an invitation to join someone's account?”
“Can I decline an invite I don't want?”
Tell an agent
Accept invitation {invite_id}.
Respond to invite {invite_id} with {status}.
GET /user/load_balancers/monitors List my load balancer health monitors · Cloudflare List Monitors #
Ask an LLM
“What health check monitors have I set up for my load balancers?”
“Which monitors exist on my user account?”
Tell an agent
List all my load balancer monitors.
Show every health monitor configured for my user.
POST /user/load_balancers/monitors Create a load balancer health monitor · Cloudflare Create Monitor #
Ask an LLM
“How do I set up a health check that probes my origins over HTTPS?”
“Can a new monitor look for a specific string in the response body?”
Tell an agent
Create a {type} monitor that checks path {path} every {interval} seconds.
Set up a new health monitor expecting status {expected_codes} and body text {expected_body}.
DELETE /user/load_balancers/monitors/{monitor_id} Delete a load balancer monitor · Cloudflare Delete Monitor #
Ask an LLM
“How do I remove a health monitor I no longer need?”
“Can I delete a monitor that pools might still reference?”
Tell an agent destructive · confirm first
Delete monitor {monitor_id}.
Remove health monitor {monitor_id} from my account.
GET /user/load_balancers/monitors/{monitor_id} Get one load balancer monitor · Cloudflare Monitor Details #
Ask an LLM
“What settings does a particular health monitor use?”
“Can I see the interval and expected codes of one monitor?”
Tell an agent
Show the configuration of monitor {monitor_id}.
Get details for health monitor {monitor_id}.
PATCH /user/load_balancers/monitors/{monitor_id} Change selected settings on a monitor · Cloudflare Patch Monitor #
Ask an LLM
“Can I change just the interval of a health monitor without resending everything?”
“Is it possible to tweak only a monitor's timeout?”
Tell an agent
Patch monitor {monitor_id} to run every {interval} seconds.
Change only the description of monitor {monitor_id} to {description}.
PUT /user/load_balancers/monitors/{monitor_id} Replace a monitor's configuration · Cloudflare Update Monitor #
Ask an LLM
“How do I fully replace the settings of an existing health monitor?”
“Can I rewrite a monitor's whole configuration in one request?”
Tell an agent
Replace monitor {monitor_id} with a {type} check on path {path}.
Overwrite the full config of monitor {monitor_id}, using method {method} and {retries} retries.
POST /user/load_balancers/monitors/{monitor_id}/preview Preview pools against a monitor's settings · Cloudflare Preview Monitor #
Ask an LLM
“Can I test how my pools would fare with changed monitor settings before saving them?”
“How do I dry-run a monitor change against the pools that use it?”
Tell an agent
Preview the pools using monitor {monitor_id} with path {path} and expected codes {expected_codes}.
Start a monitor preview for {monitor_id} with a {timeout} second timeout.
GET /user/load_balancers/monitors/{monitor_id}/references List what references a monitor · Cloudflare List Monitor References #
Ask an LLM
“Which pools are using a given health monitor?”
“What would be affected if I deleted this monitor?”
Tell an agent
List the resources that reference monitor {monitor_id}.
Show which pools depend on monitor {monitor_id}.
GET /user/load_balancers/pools List my load balancer pools · Cloudflare List Pools #
Ask an LLM
“What origin pools have I configured?”
“Can I list only the pools that use a particular monitor?”
Tell an agent
List all my load balancer pools.
Show the pools that use monitor {monitor}.
PATCH /user/load_balancers/pools Update the notification email on many pools · Cloudflare Patch Pools #
Ask an LLM
“Can I change the health notification email on all my pools at once?”
“Is there a bulk way to clear the notification address across every pool?”
Tell an agent
Set the notification email on all my pools to {notification_email}.
Bulk-update every pool to send health alerts to {notification_email}.
POST /user/load_balancers/pools Create a load balancer origin pool · Cloudflare Create Pool #
Ask an LLM
“How do I group my origin servers into a new pool?”
“Can I require a minimum number of healthy origins when setting up a pool?”
Tell an agent
Create a pool named {name} with origins {origins}.
Create pool {name} with origins {origins}, checked by monitor {monitor}.
DELETE /user/load_balancers/pools/{pool_id} Delete a load balancer pool · Cloudflare Delete Pool #
Ask an LLM
“How do I get rid of an origin pool I no longer use?”
“Can I delete a pool permanently?”
Tell an agent destructive · confirm first
Delete pool {pool_id}.
Remove load balancer pool {pool_id} from my account.
GET /user/load_balancers/pools/{pool_id} Get one load balancer pool · Cloudflare Pool Details #
Ask an LLM
“Which origins and monitor does a specific pool use?”
“Can I see the full configuration of one pool?”
Tell an agent
Show the configuration of pool {pool_id}.
Get details for load balancer pool {pool_id}.
PATCH /user/load_balancers/pools/{pool_id} Change selected settings on one pool · Cloudflare Patch Pool #
Ask an LLM
“Can I disable a single pool without resending its origins?”
“Is it possible to change just the monitor attached to one pool?”
Tell an agent
Patch pool {pool_id} to set enabled to {enabled}.
Switch pool {pool_id} to use monitor {monitor}, leaving everything else as is.
PUT /user/load_balancers/pools/{pool_id} Replace a pool's configuration · Cloudflare Update Pool #
Ask an LLM
“How do I replace the whole origin list and settings of an existing pool?”
“Can I rewrite a pool's full configuration in one call?”
Tell an agent
Replace pool {pool_id} with name {name} and origins {origins}.
Overwrite pool {pool_id} as {name} with origins {origins} and load shedding {load_shedding}.
GET /user/load_balancers/pools/{pool_id}/health Check a pool's current health · Cloudflare Pool Health Details #
Ask an LLM
“Is my origin pool healthy right now?”
“What's the latest health status of a specific pool?”
Tell an agent
Show the latest health status of pool {pool_id}.
Check whether pool {pool_id} is healthy.
POST /user/load_balancers/pools/{pool_id}/preview Preview a pool's health with test monitor settings · Cloudflare Preview Pool #
Ask an LLM
“Can I see how one pool's origins would respond to a different health check before applying it?”
“How do I trial monitor settings against a single pool?”
Tell an agent
Preview health of pool {pool_id} using a {type} check on path {path}.
Run a health preview on pool {pool_id} with port {port}.
GET /user/load_balancers/pools/{pool_id}/references List what references a pool · Cloudflare List Pool References #
Ask an LLM
“Which load balancers route traffic to a given pool?”
“What depends on this pool before I remove it?”
Tell an agent
List the resources that reference pool {pool_id}.
Show which load balancers use pool {pool_id}.
GET /user/load_balancers/preview/{preview_id} Get the result of a health preview · Cloudflare Preview Result #
Ask an LLM
“Where do I find the outcome of a monitor or pool preview I started?”
“Did my previewed health check pass?”
Tell an agent
Get the results of preview {preview_id}.
Show whether origins passed in health preview {preview_id}.
GET /user/load_balancing_analytics/events List origin health change events · Cloudflare List Healthcheck Events #
Ask an LLM
“When did my origins go up or down recently?”
“Can I filter health check events to just one pool or origin?”
Tell an agent
List origin health changes since {since}.
Show health events for pool {pool_name} until {until}.
GET /user/organizations List organizations I belong to · Cloudflare List Organizations #
Ask an LLM
“Which organizations is my user a member of?”
“Can I search my organizations by name or status?”
Tell an agent
List the organizations I'm associated with.
Find my organizations named {name}.
DELETE /user/organizations/{organization_id} Leave an organization · Cloudflare Leave Organization #
Ask an LLM
“How do I remove myself from an organization?”
“Can I drop my association with an organization I no longer work with?”
Tell an agent destructive · confirm first
Leave organization {organization_id}.
Remove my membership in organization {organization_id}.
GET /user/organizations/{organization_id} Get one organization I belong to · Cloudflare Organization Details #
Ask an LLM
“What are the details of a specific organization I'm in?”
“Can I look up one organization's info by its ID?”
Tell an agent
Show details for organization {organization_id}.
Get organization {organization_id}.
GET /user/subscriptions List my subscriptions · Cloudflare Get User Subscriptions #
Ask an LLM
“What plans and add-ons am I currently subscribed to?”
“When is my next subscription billing due?”
Tell an agent
List all my user subscriptions.
Show my active subscriptions and their prices.
DELETE /user/subscriptions/{identifier} Cancel a user subscription · Cloudflare Delete User Subscription #
Ask an LLM
“How do I cancel one of my subscriptions?”
“Can I delete a subscription I'm no longer using?”
Tell an agent destructive · confirm first
Delete subscription {identifier}.
Cancel my subscription {identifier}.
PUT /user/subscriptions/{identifier} Change a user subscription · Cloudflare Update User Subscription #
Ask an LLM
“How do I switch one of my subscriptions to a different rate plan?”
“Can I change how often a subscription renews?”
Tell an agent
Change subscription {identifier} to rate plan {rate_plan}.
Set subscription {identifier} to renew {frequency}.
GET /user/tokens List my API tokens · Cloudflare List Tokens #
Ask an LLM
“Which API tokens have I created?”
“Can I page through my access tokens in a set order?”
Tell an agent
List all the API tokens I've created.
Show page {page} of my API tokens.
POST /user/tokens Create an API token · Cloudflare Create Token #
Ask an LLM
“How do I make a scoped API token with specific permissions?”
“Can I create a token that expires on a set date?”
Tell an agent
Create an API token named {name} with policies {policies}.
Create token {name} with policies {policies} that expires on {expires_on}.
DELETE /user/tokens/{token_id} Delete an API token · Cloudflare Delete Token #
Ask an LLM
“How do I permanently destroy an API token?”
“Can I delete a token I think has leaked?”
Tell an agent destructive · confirm first
Delete API token {token_id}.
Destroy token {token_id} so it can't be used again.
GET /user/tokens/{token_id} Get one API token's details · Cloudflare Token Details #
Ask an LLM
“What permissions and expiry does a particular API token have?”
“Can I check when a specific token was issued?”
Tell an agent
Show details of API token {token_id}.
Get the policies attached to token {token_id}.
PUT /user/tokens/{token_id} Update an API token's settings · Cloudflare Update Token #
Ask an LLM
“How do I change the permissions on an existing API token?”
“Can I disable a token by changing its status?”
Tell an agent
Update token {token_id} with name {name}, policies {policies} and status {status}.
Set token {token_id} ({id}) named {name} to status {status} keeping policies {policies}.
PUT /user/tokens/{token_id}/value Roll an API token's secret · Cloudflare Roll Token #
Ask an LLM
“How do I regenerate the secret value of an existing token?”
“Can I rotate a token's secret without changing its permissions?”
Tell an agent destructive · confirm first
Roll the secret for token {token_id}.
Rotate the value of API token {token_id}.
GET /user/tokens/permission_groups List available token permission groups · Cloudflare List Permission Groups #
Ask an LLM
“What permission groups can I assign to an API token?”
“Which permissions are available when building a token policy?”
Tell an agent
List all available permission groups.
Show the permission groups I can use in token policies.
GET /user/tokens/verify Verify that my API token works · Cloudflare Verify Token #
Ask an LLM
“Is the API token I'm calling with valid and active?”
“Can I quickly test whether my current token works?”
Tell an agent
Verify the token I'm using.
Check that my current API token is active.
GET /user/tenants List user tenants #

Documentation

📖
Documentation
https://developers.cloudflare.com/api/
📖
GettingStarted
https://developers.cloudflare.com/fundamentals/api/get-started/
📖
Authentication
https://developers.cloudflare.com/fundamentals/api/get-started/create-token/
📖
RateLimits
https://developers.cloudflare.com/fundamentals/api/reference/limits/
📖
Documentation
https://developers.cloudflare.com/api/operations/accounts-list-accounts
📖
APIReference
https://developers.cloudflare.com/api/resources/accounts/
📖
APIReference
https://developers.cloudflare.com/ssl/
📖
Documentation
https://developers.cloudflare.com/api/operations/ip-access-rules-for-a-user-list-ip-access-rules
📖
Documentation
https://developers.cloudflare.com/api/operations/user'-s-account-memberships-list-memberships
📖
Documentation
https://developers.cloudflare.com/api/operations/radar-get-search-global
📖
APIReference
https://developers.cloudflare.com/radar/
📖
GettingStarted
https://developers.cloudflare.com/radar/get-started/
📖
Documentation
https://developers.cloudflare.com/api/operations/user-user-details
📖
APIReference
https://developers.cloudflare.com/api/resources/user/
📖
Documentation
https://developers.cloudflare.com/api/operations/zones-get
📖
APIReference
https://developers.cloudflare.com/api/resources/zones/
📖
Documentation
https://developers.cloudflare.com/dns/
📖
APIReference
https://developers.cloudflare.com/api/resources/dns/
📖
Documentation
https://developers.cloudflare.com/workers/
📖
APIReference
https://developers.cloudflare.com/api/resources/workers/
📖
GettingStarted
https://developers.cloudflare.com/workers/get-started/
📖
Documentation
https://developers.cloudflare.com/workers-ai/
📖
GettingStarted
https://developers.cloudflare.com/workers-ai/get-started/rest-api/
📖
APIReference
https://developers.cloudflare.com/workers-ai/configuration/open-ai-compatibility/
📖
APIReference
https://developers.cloudflare.com/workers-ai/models/
📖
Documentation
https://developers.cloudflare.com/ai-gateway/
📖
APIReference
https://developers.cloudflare.com/ai-gateway/usage/providers/
📖
GettingStarted
https://developers.cloudflare.com/ai-gateway/get-started/
📖
Documentation
https://developers.cloudflare.com/r2/
📖
APIReference
https://developers.cloudflare.com/r2/api/s3/api/
📖
GettingStarted
https://developers.cloudflare.com/r2/get-started/
📖
Documentation
https://developers.cloudflare.com/d1/
📖
APIReference
https://developers.cloudflare.com/api/resources/d1/
📖
GettingStarted
https://developers.cloudflare.com/d1/get-started/
📖
Documentation
https://developers.cloudflare.com/kv/
📖
APIReference
https://developers.cloudflare.com/api/resources/kv/
📖
GettingStarted
https://developers.cloudflare.com/kv/get-started/
📖
Documentation
https://developers.cloudflare.com/queues/
📖
APIReference
https://developers.cloudflare.com/api/resources/queues/
📖
GettingStarted
https://developers.cloudflare.com/queues/get-started/
📖
Documentation
https://developers.cloudflare.com/durable-objects/
📖
GettingStarted
https://developers.cloudflare.com/durable-objects/get-started/
📖
APIReference
https://developers.cloudflare.com/durable-objects/api/
📖
Documentation
https://developers.cloudflare.com/vectorize/
📖
GettingStarted
https://developers.cloudflare.com/vectorize/get-started/intro/
📖
APIReference
https://developers.cloudflare.com/vectorize/reference/client-api/
📖
Documentation
https://developers.cloudflare.com/pages/
📖
APIReference
https://developers.cloudflare.com/pages/configuration/api/
📖
GettingStarted
https://developers.cloudflare.com/pages/get-started/
📖
Documentation
https://developers.cloudflare.com/stream/
📖
GettingStarted
https://developers.cloudflare.com/stream/get-started/
📖
APIReference
https://developers.cloudflare.com/api/resources/stream/
📖
Documentation
https://developers.cloudflare.com/images/
📖
GettingStarted
https://developers.cloudflare.com/images/get-started/
📖
APIReference
https://developers.cloudflare.com/api/resources/images/
📖
Documentation
https://developers.cloudflare.com/turnstile/
📖
GettingStarted
https://developers.cloudflare.com/turnstile/get-started/
📖
APIReference
https://developers.cloudflare.com/api/resources/turnstile/
📖
Documentation
https://developers.cloudflare.com/logs/
📖
APIReference
https://developers.cloudflare.com/api/resources/logpush/
📖
GettingStarted
https://developers.cloudflare.com/logs/get-started/
📖
Documentation
https://developers.cloudflare.com/hyperdrive/
📖
APIReference
https://developers.cloudflare.com/api/resources/hyperdrive/
📖
GettingStarted
https://developers.cloudflare.com/hyperdrive/get-started/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/openapi/cloudflare-user-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/asyncapi/cloudflare-notifications-webhooks-asyncapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/asyncapi/cloudflare-stream-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/json-schema/cloudflare-load-balancing-monitor-editable-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/json-schema/cloudflare-load-balancing-load-shedding-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/json-schema/cloudflare-iam-schemas-response-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/json-schema/cloudflare-load-balancing-origin-steering-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/json-schema/cloudflare-bill-subs-api-subscription-v2-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/json-schema/cloudflare-load-balancing-schemas-references-response-schema.json

Other Resources

🔗
SDKs
https://developers.cloudflare.com/fundamentals/api/reference/sdks/
🔗
Pricing
https://developers.cloudflare.com/workers-ai/platform/pricing/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudflare:cloudflare-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudflare-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cloudflare User API
  version: 4.0.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  description: 'Operations tagged User across 2 of this provider''s published API definitions: cloudflare-openapi-original.yml, cloudflare-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:


# --- truncated at 32 KB (148 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/openapi/cloudflare-user-api-openapi.yml