Cloudflare User API
The User API from Cloudflare — 28 operation(s) for user.
Cloudflare User API is one of 87 APIs that Cloudflare publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an AsyncAPI specification, API documentation, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 46 operations across 28 paths, and defines 195 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.
Requests are made against a single base URL, https://api.cloudflare.com/client/v4.
46 operations
28 paths
195 schemas
6 DELETE23 GET6 PATCH6 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Cloudflare User API declares
4 security schemes
for authenticating requests.
An API key is passed in the header as X-Auth-Email (api_email).
An API key is passed in the header as X-Auth-Key (api_key).
It accepts HTTP bearer tokens (api_token).
An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).
By default, every request must be authenticated.
Paths & Operations 46
Across 28 paths, the API surfaces 46 operations — 6 DELETE, 23 GET, 6 PATCH, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
User 46
GET
/user
Cloudflare User Details
PATCH
/user
Cloudflare Edit User
GET
/user/audit_logs
Cloudflare Get user audit logs
GET
/user/billing/historydeprecated
Cloudflare Billing History Details
GET
/user/billing/profiledeprecated
Cloudflare Billing Profile Details
GET
/user/firewall/access_rules/rules
Cloudflare List IP Access rules
POST
/user/firewall/access_rules/rules
Cloudflare Create an IP Access rule
DELETE
/user/firewall/access_rules/rules/{identifier}
Cloudflare Delete an IP Access rule
PATCH
/user/firewall/access_rules/rules/{identifier}
Cloudflare Update an IP Access rule
GET
/user/invites
Cloudflare List Invitations
GET
/user/invites/{invite_id}
Cloudflare Invitation Details
PATCH
/user/invites/{invite_id}
Cloudflare Respond to Invitation
GET
/user/load_balancers/monitors
Cloudflare List Monitors
POST
/user/load_balancers/monitors
Cloudflare Create Monitor
DELETE
/user/load_balancers/monitors/{monitor_id}
Cloudflare Delete Monitor
GET
/user/load_balancers/monitors/{monitor_id}
Cloudflare Monitor Details
PATCH
/user/load_balancers/monitors/{monitor_id}
Cloudflare Patch Monitor
PUT
/user/load_balancers/monitors/{monitor_id}
Cloudflare Update Monitor
POST
/user/load_balancers/monitors/{monitor_id}/preview
Cloudflare Preview Monitor
GET
/user/load_balancers/monitors/{monitor_id}/references
Cloudflare List Monitor References
GET
/user/load_balancers/pools
Cloudflare List Pools
PATCH
/user/load_balancers/pools
Cloudflare Patch Pools
POST
/user/load_balancers/pools
Cloudflare Create Pool
DELETE
/user/load_balancers/pools/{pool_id}
Cloudflare Delete Pool
GET
/user/load_balancers/pools/{pool_id}
Cloudflare Pool Details
PATCH
/user/load_balancers/pools/{pool_id}
Cloudflare Patch Pool
PUT
/user/load_balancers/pools/{pool_id}
Cloudflare Update Pool
GET
/user/load_balancers/pools/{pool_id}/health
Cloudflare Pool Health Details
POST
/user/load_balancers/pools/{pool_id}/preview
Cloudflare Preview Pool
GET
/user/load_balancers/pools/{pool_id}/references
Cloudflare List Pool References
GET
/user/load_balancers/preview/{preview_id}
Cloudflare Preview Result
GET
/user/load_balancing_analytics/events
Cloudflare List Healthcheck Events
GET
/user/organizations
Cloudflare List Organizations
DELETE
/user/organizations/{organization_id}
Cloudflare Leave Organization
GET
/user/organizations/{organization_id}
Cloudflare Organization Details
GET
/user/subscriptions
Cloudflare Get User Subscriptions
DELETE
/user/subscriptions/{identifier}
Cloudflare Delete User Subscription
PUT
/user/subscriptions/{identifier}
Cloudflare Update User Subscription
GET
/user/tokens
Cloudflare List Tokens
POST
/user/tokens
Cloudflare Create Token
DELETE
/user/tokens/{token_id}
Cloudflare Delete Token
GET
/user/tokens/{token_id}
Cloudflare Token Details
PUT
/user/tokens/{token_id}
Cloudflare Update Token
PUT
/user/tokens/{token_id}/value
Cloudflare Roll Token
GET
/user/tokens/permission_groups
Cloudflare List Permission Groups
GET
/user/tokens/verify
Cloudflare Verify Token
Schemas 195
The contract defines 195 schemas that model the data the API accepts and returns. The most detailed are load-balancing_pool (17 properties), load-balancing_monitor-editable (16 properties), bill-subs-api_subscription-v2 (11 properties), aaa_audit-logs (10 properties). Each schema is shown below with its type and property counts.
iam_policies
array
List of access policies assigned to the token.
load-balancing_schemas-enabled
boolean
Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will onl…
iam_policy_with_permission_groups
object
4 properties
4 required
aaa_audit_logs_response_collection
iam_schemas-invite
object
legacy-jhs_result_info
object
4 properties
load-balancing_preview_result_response
load-balancing_disabled_at
string
This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.
iam_api-response-single
object
bill-subs-api_rate_plan
object
The rate plan applied to the subscription.
7 properties
load-balancing_identifier
string
legacy-jhs_rule_collection_response
iam_invite_components-schemas-identifier
string
Invite identifier tag.
load-balancing_follow_redirects
boolean
Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
aaa_identifier
string
Identifier
bill-subs-api_messages
array
load-balancing_schemas-header
object
The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.
1 property
load-balancing_messages
array
load-balancing_timeout
integer
The timeout (in seconds) before marking the health check as failed.
legacy-jhs_messages
array
iam_response_single_value
load-balancing_preview_id
aaa_api-response-common
object
4 properties
4 required
bill-subs-api_subscription-v2
object
11 properties
aaa_api-response-common-failure
object
4 properties
4 required
iam_common_components-schemas-identifier
string
Identifier
load-balancing_filter_options
objectnull
Filter options for a particular resource type (pool or origin). Use null to reset.
2 properties
iam_single_invite_response
iam_create_payload
object
5 properties
2 required
load-balancing_schemas-id_response
legacy-jhs_rule_components-schemas-identifier
string
The unique identifier of the IP Access rule.
load-balancing_schemas-identifier
string
load-balancing_api-response-collection
object
load-balancing_interval
integer
The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.
bill-subs-api_price
number
The price of the subscription that will be billed, in US dollars.
iam_expires_on
string
The expiration time on or after which the JWT MUST NOT be accepted for processing.
legacy-jhs_api-response-collection
object
iam_role_components-schemas-identifier
string
Role identifier tag.
load-balancing_weight
number
The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.…
load-balancing_probe_zone
string
Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
load-balancing_schemas-name
string
A human-identifiable name for the origin.
load-balancing_api-response-common-failure
object
4 properties
4 required
bill-subs-api_components-schemas-identifier
string
Billing item identifier tag.
bill-subs-api_current_period_end
string
The end of the current period and also when the next billing is due.
iam_response_single
load-balancing_longitude
number
The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.
iam_components-schemas-status
string
Whether the user is a member of the organization or has an inivitation pending.
bill-subs-api_current_period_start
string
When the current billing period started. May match initialperiodstart if this is the first period.
iam_invited_by
string
The email address of the user who created the invite.
iam_permission_groups
array
A set of permission groups that are specified to the policy.
load-balancing_pool_name
string
The name for the pool to filter.
iam_first_name
stringnull
User's first name
load-balancing_monitor
bill-subs-api_schemas-zone
object
1 property
load-balancing_schemas-references_response
load-balancing_schemas-disabled_at
string
This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.
load-balancing_header
object
The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This para…
iam_response_single_segment
load-balancing_expected_codes
string
The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
iam_last_name
stringnull
User's last name
bill-subs-api_billing_response_single
bill-subs-api_zone
object
A simple zone object. May have null properties if not a zone subscription.
2 properties
legacy-jhs_schemas-mode
string
The action to apply to a matched request.
iam_identifier
string
Policy identifier.
bill-subs-api_name
string
The domain name
bill-subs-api_install_id
string
app install id.
load-balancing_name
string
A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.
iam_invited_on
string
When the invite was sent.
bill-subs-api_currency
string
The monetary unit in which pricing information is displayed.
bill-subs-api_component_values
array
The list of add-ons subscribed to.
load-balancing_address
string
The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a h…
load-balancing_origin_healthy
boolean
If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.
bill-subs-api_api-response-common
object
4 properties
4 required
bill-subs-api_subscription
object
load-balancing_monitor-editable
object
16 properties
load-balancing_method
string
The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connectionestablished' for TCP based health checks.
iam_schemas-expires_on
string
When the invite is no longer active.
iam_single_organization_response
load-balancing_pool
object
17 properties
load-balancing_patch_pools_notification_email
string
The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetti…
load-balancing_preview_result
object
Resulting health data from a preview operation.
load-balancing_origin
object
7 properties
bill-subs-api_user_subscription_response_collection
legacy-jhs_rule_single_id_response
bill-subs-api_api-response-collection
object
iam_api-response-common-failure
object
4 properties
4 required
iam_api-response-collection
object
bill-subs-api_amount
number
The amount associated with this billing item.
load-balancing_notification_email
string
This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/.…
bill-subs-api_api-response-single
object
bill-subs-api_result_info
object
4 properties
bill-subs-api_billing_history_collection
iam_request_ip
object
Client IP restrictions.
2 properties
iam_base
object
9 properties
2 required
iam_messages
array
iam_api-response-single-id
object
legacy-jhs_api-response-common-failure
object
4 properties
4 required
iam_issued_on
string
The time on which the token was created.
legacy-jhs_api-response-single
object
bill-subs-api_state
string
The state that the subscription is in.
legacy-jhs_cidr_configuration
object
2 properties
load-balancing_id_response
iam_condition
object
1 property
load-balancing_result_info
object
4 properties
load-balancing_monitor-response-single
bill-subs-api_action
string
The billing item action.
iam_permission_group
object
A named group of permissions that map to a group of operations against resources.
2 properties
1 required
load-balancing_consecutive_down
integer
To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
bill-subs-api_type
string
The billing item type.
aaa_audit-logs
object
10 properties
iam_resources
object
A list of resource names that the policy applies to.
iam_access-policy
object
iam_value
string
The token value.
iam_schemas-role
object
4 properties
4 required
load-balancing_virtual_network_id
string
The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.
load-balancing_components-schemas-response_collection
iam_status
string
Status of the token.
load-balancing_minimum_origins
integer
The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be m…
legacy-jhs_rule_single_response
iam_single_user_response
iam_response_create
load-balancing_preview_response
load-balancing_enabled
boolean
Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause…
aaa_messages
array
iam_collection_organization_response
iam_country
stringnull
The country in which the user lives.
load-balancing_notification_filter
objectnull
Filter pool and origin health notifications by resource type or health status. Use null to reset.
2 properties
load-balancing_origins
array
The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.
iam_cidr_list
array
List of IPv4/IPv6 CIDR addresses.
legacy-jhs_ipv6_configuration
object
2 properties
bill-subs-api_description
string
The billing item description.
legacy-jhs_ip_configuration
object
2 properties
iam_schemas-identifier
load-balancing_load_shedding
object
Configures load shedding policies and percentages for the pool.
4 properties
load-balancing_api-response-single
object
load-balancing_schemas-single_response
legacy-jhs_country_configuration
object
2 properties
iam_token
object
9 properties
4 required
bill-subs-api_schemas-identifier
string
Subscription identifier tag.
load-balancing_latitude
number
The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.
iam_name
string
Token name.
bill-subs-api_occurred_at
string
When the billing item was created.
load-balancing_health_details
iam_schemas-token
load-balancing_schemas-response_collection
iam_api-response-common
object
4 properties
4 required
legacy-jhs_rule
object
7 properties
4 required
bill-subs-api_component_value
object
A component value for a subscription.
4 properties
iam_schemas-permissions
array
Access permissions for this User.
load-balancing_type
string
The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.
load-balancing_api-response-common
object
4 properties
4 required
legacy-jhs_api-response-common
object
4 properties
4 required
iam_effect
string
Allow or deny operations against the resources.
iam_description
string
Description of role's permissions.
load-balancing_monitor_id
The ID of the Monitor to use for checking the health of origins within this pool.
load-balancing_schemas-description
string
A human-readable description of the pool.
iam_not_before
string
The time before which the token MUST NOT be accepted for processing.
iam_components-schemas-identifier
string
Token identifier tag.
load-balancing_allow_insecure
boolean
Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
iam_components-schemas-name
string
Role Name.
legacy-jhs_egs-pagination
object
2 properties
iam_schemas-response_collection
iam_zipcode
stringnull
The zipcode or postal code where the user lives.
load-balancing_until
string
End date and time of requesting data period in the ISO8601 format.
load-balancing_origin_steering
object
Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.
1 property
iam_response_collection
iam_schemas-collection_invite_response
iam_user_invite
bill-subs-api_user_subscription_response_single
bill-subs-api_identifier
string
Identifier
load-balancing_timestamp
string
iam_schemas-name
string
Organization name.
load-balancing_description
string
Object description.
legacy-jhs_schemas-filters
object
5 properties
bill-subs-api_billing-history
object
8 properties
8 required
legacy-jhs_asn_configuration
object
2 properties
legacy-jhs_notes
string
An informative summary of the rule, typically used as a reminder or explanation.
iam_telephone
stringnull
User's telephone number
bill-subs-api_frequency
string
How often the subscription is renewed automatically.
iam_invited_member_email
string
Email address of the user to add to the organization.
load-balancing_references_response
load-balancing_monitor-response-collection
load-balancing_path
string
The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
bill-subs-api_api-response-common-failure
object
4 properties
4 required
load-balancing_expected_body
string
A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only val…
load-balancing_port
integer
The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-…
load-balancing_Host
array
The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.
iam_organization
object
5 properties
load-balancing_check_regions
arraynull
A list of regions from which to run health checks. Null means every Cloudflare data center.
legacy-jhs_schemas-configuration
object
The rule configuration.
load-balancing_retries
integer
The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
iam_modified_on
string
Last time the token was modified.
load-balancing_consecutive_up
integer
To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
load-balancing_analytics
object
4 properties
iam_result_info
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cloudflare 12
Other APIs Cloudflare publishes across the network.
Cloudflare Load Balancing API
Cloudflare WAF API
Cloudflare GraphQL Analytics API
Cloudflare Magic Transit API
Cloudflare Email Routing API
Cloudflare Waiting Room API
Cloudflare Spectrum API
Cloudflare API Shield API
Cloudflare Zero Trust API
Cloudflare Registrar API
Cloudflare Workflows API
Cloudflare Browser Rendering API
#User
Where this information came from
This is an independent, third-party profile of Cloudflare User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.