Cloudflare Accounts API
Managing all the details of your Cloudflare Account using the API.
OpenAPI Specification
openapi: 3.0.3
components:
schemas:
iam_response_single:
allOf:
- $ref: '#/components/schemas/iam_api-response-single'
- type: object
properties:
result:
type: object
addressing_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_address-maps'
addressing_full_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- type: object
properties:
result:
allOf:
- $ref: '#/components/schemas/addressing_address-maps'
- type: object
properties:
ips:
$ref: '#/components/schemas/addressing_schemas-ips'
memberships:
$ref: '#/components/schemas/addressing_memberships'
addressing_api-response-collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/addressing_result_info'
type: object
addressing_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_address-maps'
addressing_response_collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_ipam-prefixes'
addressing_single_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_ipam-prefixes'
addressing_response_collection_bgp:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
addressing_single_response_bgp:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_ipam-bgp-prefixes'
addressing_advertised_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
type: object
properties:
advertised:
$ref: '#/components/schemas/addressing_schemas-advertised'
advertised_modified_at:
$ref: '#/components/schemas/addressing_modified_at_nullable'
addressing_api-response-common:
type: object
required:
- success
- errors
- messages
- result
properties:
errors:
$ref: '#/components/schemas/addressing_messages'
messages:
$ref: '#/components/schemas/addressing_messages'
result:
anyOf:
- type: object
- type: array
items: {}
- type: string
success:
type: boolean
description: Whether the API call was successful
enum:
- true
example: true
addressing_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/addressing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/addressing_ipam-delegations'
addressing_schemas-single_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/addressing_ipam-delegations'
addressing_id_response:
allOf:
- $ref: '#/components/schemas/addressing_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/addressing_delegation_identifier'
aaa_response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: object
example:
Origin Monitoring:
- description: High levels of 5xx HTTP errors at your origin.
display_name: Origin Error Rate Alert
filter_options:
- AvailableValues:
ComparisonOperator: '=='
Key: zones
Range: 1-n
- AvailableValues:
- Description: Service-Level Objective of 99.7
ID: '99.7'
- Description: Service-Level Objective of 99.8
ID: '99.8'
ComparisonOperator: '>='
Key: slo
Range: 0-1
type: http_alert_origin_error
aaa_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: object
example:
email:
eligible: true
ready: true
type: email
aaa_api-response-collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-common'
- properties:
result:
type: array
nullable: true
items: {}
result_info:
$ref: '#/components/schemas/aaa_result_info'
type: object
aaa_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/aaa_pagerduty'
aaa_id_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/aaa_uuid'
aaa_webhooks_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/aaa_webhooks'
aaa_schemas-single_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
$ref: '#/components/schemas/aaa_webhooks'
aaa_history_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
example:
- alert_body:
data:
custom_csr_id: ''
expires_on:
hosts: []
id: '11111111111'
issuer: ''
method: txt
serial_number: ''
settings:
signature: ''
status: ''
type: ''
uploaded_on:
validation_errors: []
validation_records:
- cname: ''
cname_target: ''
emails: []
http_body: ''
http_url: ''
txt_name: _acme-challenge.example.com
txt_value: '11111111111'
metadata:
account:
event:
created_at:
id: ''
type: ssl.certificate.validation.failed
zone:
id: '11111111111'
alert_type: universal_ssl_event_type
description: >-
Universal Certificate validation status, issuance, renewal,
and expiration notices.
id: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
mechanism: [email protected]
mechanism_type: email
name: SSL Notification Event Policy
policy_id: 35040955-3102-4710-938c-0f4eaf736e25
sent: '2021-10-08T17:52:17.571336Z'
items:
$ref: '#/components/schemas/aaa_history'
result_info:
type: object
example:
count: 1
page: 1
per_page: 20
aaa_policies_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/aaa_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/aaa_policies'
aaa_single_response:
allOf:
- $ref: '#/components/schemas/aaa_api-response-single'
- properties:
result:
$ref: '#/components/schemas/aaa_policies'
aaa_audit_logs_response_collection:
oneOf:
- properties:
errors:
type: object
nullable: true
messages:
type: array
example: []
items: {}
result:
type: array
items:
$ref: '#/components/schemas/aaa_audit-logs'
success:
type: boolean
example: true
- $ref: '#/components/schemas/aaa_api-response-common'
intel_phishing-url-submit_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_phishing-url-submit'
intel_phishing-url-info_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/intel_api-response-single'
- properties:
result:
$ref: '#/components/schemas/intel_phishing-url-info'
calls_app_response_collection:
allOf:
- $ref: '#/components/schemas/calls_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/calls_app'
calls_app_response_single:
allOf:
- $ref: '#/components/schemas/calls_api-response-single'
- properties:
result:
$ref: '#/components/schemas/calls_app'
tunnel_tunnel-response-collection:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-collection'
- type: object
properties:
result:
type: array
items:
anyOf:
- $ref: '#/components/schemas/tunnel_cfd_tunnel'
- $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
tunnel_tunnel-response-single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
anyOf:
- $ref: '#/components/schemas/tunnel_cfd_tunnel'
- $ref: '#/components/schemas/tunnel_warp_connector_tunnel'
tunnel_config_response_single:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
type: object
tunnel_empty_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-common'
- type: object
properties:
result:
type: object
tunnel_tunnel_connections_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/tunnel_tunnel_client'
tunnel_tunnel_client_response:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/tunnel_tunnel_client'
tunnel_tunnel_response_token:
allOf:
- $ref: '#/components/schemas/tunnel_api-response-single'
- type: object
properties:
result:
type: string
example: eyJhIjoiNWFiNGU5Z...
dns-custom-nameservers_acns_response_collection:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/dns-custom-nameservers_CustomNS'
dns-custom-nameservers_acns_response_single:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns-custom-nameservers_CustomNS'
dns-custom-nameservers_empty_response:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
maxItems: 0
items: {}
dns-custom-nameservers_availability_response:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
items:
type: string
format: hostname
description: >-
Name of zone based on which account custom nameservers can be
created. For example, if example.com is returned, then
ns1.example.com can be used as an account custom nameserver.
example: example.com
readOnly: true
teams-devices_devices_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_devices'
teams-devices_device_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
type: object
teams-devices_override_codes_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: object
properties:
disable_for_time:
$ref: '#/components/schemas/teams-devices_disable_for_time'
teams-devices_dex-response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection-common'
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/teams-devices_device-dex-test-schemas-http
teams-devices_dex-single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-dex-test-schemas-http'
teams-devices_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-managed-networks'
teams-devices_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-managed-networks'
teams-devices_device_settings_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device_settings_policy'
teams-devices_default_device_settings_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
$ref: >-
#/components/schemas/teams-devices_default_device_settings_policy
teams-devices_device_settings_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device_settings_policy'
teams-devices_split_tunnel_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel'
teams-devices_fallback_domain_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_fallback_domain'
teams-devices_split_tunnel_include_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_split_tunnel_include'
teams-devices_response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-posture-rules'
teams-devices_single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-posture-rules'
teams-devices_id_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/teams-devices_uuid'
teams-devices_schemas-response_collection:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/teams-devices_device-posture-integrations'
teams-devices_schemas-single_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: '#/components/schemas/teams-devices_device-posture-integrations'
teams-devices_schemas-id_response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
type: object
nullable: true
teams-devices_api-response-single:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-common'
- properties:
result:
anyOf:
- type: object
- type: string
type: object
nullable: true
type: object
teams-devices_zero-trust-account-device-settings-response:
allOf:
- $ref: '#/components/schemas/teams-devices_api-response-single'
- properties:
result:
$ref: >-
#/components/schemas/teams-devices_zero-trust-account-device-settings
type: object
digital-experience-monitoring_fleet_status_devices_response:
allOf:
- $ref: >-
#/components/schemas/digital-experience-monitoring_api-response-collection
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/digital-experience-monitoring_device'
digital-experience-monitoring_fleet_status_live_response:
allOf:
- $ref: >-
#/components/schemas/digital-experience-monitoring_api-response-single
- type: object
properties:
result:
type: object
properties:
deviceStats:
type: object
properties:
byColo:
type: array
nullable: true
items:
$ref: >-
#/components/schemas/digital-experience-monitoring_live_stat
byMode:
type: array
nullable: true
items:
$ref: >-
#/components/schemas/digital-experience-monitoring_live_stat
byPlatform:
type: array
nullable: true
items:
$ref: >-
#/components/schemas/digital-experience-monitoring_live_stat
byStatus:
type: array
nullable: true
items:
$ref: >-
#/components/schemas/digital-experience-monitoring_live_stat
byVersion:
type: array
nullable: true
items:
$ref: >-
#/components/schemas/digital-experience-monitoring_live_stat
uniqueDevicesTotal:
$ref: >-
#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal
magic-transit_traceroute_response_collection:
allOf:
- $ref: '#/components/schemas/magic-transit_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/magic-transit_target_result'
dlp_DatasetArrayResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_DatasetArray'
dlp_DatasetCreationResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_DatasetCreation'
dlp_DatasetResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_Dataset'
dlp_DatasetNewVersionResponse:
allOf:
- $ref: '#/components/schemas/dlp_V4Response'
- type: object
properties:
result:
$ref: '#/components/schemas/dlp_DatasetNewVersion'
dlp_validate_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
properties:
valid:
type: boolean
example: true
dlp_get_settings_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
required:
- public_key
properties:
public_key:
type: string
example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=
nullable: true
dlp_update_settings_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
required:
- public_key
properties:
public_key:
type: string
example: EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=
nullable: true
dlp_response_collection:
allOf:
- $ref: '#/components/schemas/dlp_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/dlp_profiles'
dlp_either_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
anyOf:
- $ref: '#/components/schemas/dlp_predefined_profile'
- $ref: '#/components/schemas/dlp_custom_profile'
- $ref: '#/components/schemas/dlp_integration_profile'
dlp_create_custom_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/dlp_custom_profile'
dlp_api-response-single:
allOf:
- $ref: '#/components/schemas/dlp_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
dlp_custom_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/dlp_custom_profile'
dlp_custom_profile:
type: object
title: Custom profile
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
created_at:
$ref: '#/components/schemas/dlp_timestamp'
description:
type: string
description: The description of the profile.
example: A standard CVV card number
entries:
type: array
description: The entries for this profile.
items:
$ref: '#/components/schemas/dlp_custom_entry'
id:
$ref: '#/components/schemas/dlp_profile_id'
name:
type: string
description: The name of the profile.
example: Generic CVV Card Number
type:
type: string
description: The type of the profile.
enum:
- custom
example: custom
updated_at:
$ref: '#/components/schemas/dlp_timestamp'
dlp_predefined_profile_response:
allOf:
- $ref: '#/components/schemas/dlp_api-response-single'
- properties:
result:
allOf:
- $ref: '#/components/schemas/dlp_predefined_profile'
dlp_predefined_profile:
type: object
title: Predefined profile
properties:
allowed_match_count:
$ref: '#/components/schemas/dlp_allowed_match_count'
context_awareness:
$ref: '#/components/schemas/dlp_ContextAwareness'
entries:
type: array
description: The entries for this profile.
items:
$ref: '#/components/schemas/dlp_predefined_entry'
id:
$ref: '#/components/schemas/dlp_profile_id'
name:
type: string
description: The name of the profile.
example: Generic CVV Card Number
type:
type: string
description: The type of the profile.
enum:
- predefined
example: predefined
dns-firewall_dns_firewall_response_collection:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/dns-firewall_dns-firewall'
dns-firewall_dns_firewall_single_response:
allOf:
- $ref: '#/components/schemas/dns-firewall_api-response-single'
- properties:
result:
$ref: '#/components/schemas/dns-firewall_dns-firewall'
zero-trust-gateway_gateway_account:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
type: object
properties:
gateway_tag:
$ref: '#/components/schemas/zero-trust-gateway_gateway_tag'
id:
$ref: '#/components/schemas/zero-trust-gateway_cf_account_id'
provider_name:
$ref: '#/components/schemas/zero-trust-gateway_provider_name'
type: object
zero-trust-gateway_app-types_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_app-types'
zero-trust-gateway_audit_ssh_settings_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
$ref: '#/components/schemas/zero-trust-gateway_settings'
zero-trust-gateway_categories_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_categories'
zero-trust-gateway_gateway_account_config:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
allOf:
- $ref: >-
#/components/schemas/zero-trust-gateway_gateway-account-settings
- properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
updated_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
type: object
type: object
zero-trust-gateway_response_collection:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/zero-trust-gateway_lists'
zero-trust-gateway_single_response_with_list_items:
allOf:
- $ref: '#/components/schemas/zero-trust-gateway_api-response-single'
- properties:
result:
properties:
created_at:
$ref: '#/components/schemas/zero-trust-gateway_timestamp'
description:
$ref: '#/components/schemas/zero-trust-gateway_description'
id:
$ref: '#/components/schemas/zero-trust-gateway_uuid'
items:
$ref: '#/components/schemas/zero-trust-gateway_items'
name:
$ref: '#/components/schemas/zero-trust-gateway_name'
type:
$ref: '#/components/schemas/zero-trust-gateway_type'
updated_at:
$ref: '#/components/schemas/z
# --- truncated at 32 KB (1341 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/openapi/cloudflare-accounts--openapi-original.yml