Cloudflare Zones API
Provides the ability to manage DNS Zones across the Cloudflare platform.
OpenAPI Specification
openapi: 3.0.3
components:
schemas:
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
access_apps_components-schemas-response_collection-2:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_schemas-apps'
access_apps_components-schemas-single_response-2:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_schemas-apps'
access_policy_check_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
type: object
properties:
app_state:
type: object
properties:
app_uid:
$ref: '#/components/schemas/access_uuid'
aud:
type: string
example: >-
737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389
hostname:
type: string
example: test.com
name:
type: string
example: Test App
policies:
type: array
example:
- decision: allow
exclude: []
include:
- _type: email
email: [email protected]
precedence: 0
require: []
status: Success
items: {}
status:
type: string
example: Success
user_identity:
type: object
properties:
account_id:
type: string
example: 41ecfbb341f033e52b46742756aabb8b
device_sessions:
type: object
example: {}
email:
type: string
example: [email protected]
geo:
type: object
properties:
country:
type: string
example: US
iat:
type: integer
id:
type: string
example: '1164449231815010287495'
is_gateway:
type: boolean
example: false
is_warp:
type: boolean
example: false
name:
type: string
example: Test User
user_uuid:
$ref: '#/components/schemas/access_uuid'
version:
type: integer
access_ca_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
type: object
access_policies_components-schemas-response_collection-2:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_schemas-policies'
access_policies_components-schemas-single_response-2:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_schemas-policies'
access_ca_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_ca'
access_certificates_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_certificates'
access_components-schemas-id_response:
allOf:
- $ref: '#/components/schemas/access_api-response-common'
- properties:
result:
type: object
properties:
id:
$ref: '#/components/schemas/access_uuid'
access_certificates_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_certificates'
access_response_collection_hostnames:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_settings'
access_groups_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_schemas-groups'
access_groups_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_schemas-groups'
access_identity-providers_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- type: object
properties:
result:
type: array
items:
anyOf:
- $ref: '#/components/schemas/access_schemas-azureAD'
- $ref: '#/components/schemas/access_schemas-centrify'
- $ref: '#/components/schemas/access_schemas-facebook'
- $ref: '#/components/schemas/access_schemas-github'
- $ref: '#/components/schemas/access_schemas-google'
- $ref: '#/components/schemas/access_schemas-google-apps'
- $ref: '#/components/schemas/access_schemas-linkedin'
- $ref: '#/components/schemas/access_schemas-oidc'
- $ref: '#/components/schemas/access_schemas-okta'
- $ref: '#/components/schemas/access_schemas-onelogin'
- $ref: '#/components/schemas/access_schemas-pingone'
- $ref: '#/components/schemas/access_schemas-saml'
- $ref: '#/components/schemas/access_schemas-yandex'
- $ref: '#/components/schemas/access_schemas-onetimepin'
type: object
access_identity-providers_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_schemas-identity-providers'
access_organizations_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_schemas-organizations'
access_empty_response:
allOf:
- properties:
result:
type: boolean
enum:
- true
- false
example: true
success:
type: boolean
enum:
- true
- false
example: true
access_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/access_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/access_service-tokens'
access_service-tokens_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/access_api-response-single'
- properties:
result:
$ref: '#/components/schemas/access_service-tokens'
bill-subs-api_zone_subscription_response_single:
allOf:
- $ref: '#/components/schemas/bill-subs-api_api-response-single'
- type: object
properties:
result:
type: object
zones_api-response-single-id:
allOf:
- $ref: '#/components/schemas/zones_api-response-common'
- properties:
result:
type: object
nullable: true
required:
- id
properties:
id:
$ref: '#/components/schemas/zones_identifier'
type: object
tls-certificates-and-hostnames_total_tls_settings_response:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
properties:
certificate_authority:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority
enabled:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled
validity_days:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_schemas-validity_days
argo-analytics_response_single:
allOf:
- $ref: '#/components/schemas/argo-analytics_api-response-single'
- type: object
properties:
result:
type: object
api-shield_single_response:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-single'
- properties:
result:
$ref: '#/components/schemas/api-shield_configuration'
api-shield_default_response:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-single'
api-shield_schema_response_discovery:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-single'
- properties:
result:
type: object
properties:
schemas:
type: array
items:
$ref: '#/components/schemas/api-shield_openapi'
timestamp:
$ref: '#/components/schemas/api-shield_timestamp'
api-shield_patch_discoveries_response:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-single'
- properties:
result:
$ref: >-
#/components/schemas/api-shield_api_discovery_patch_multiple_request
api-shield_patch_discovery_response:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-single'
- properties:
result:
type: object
properties:
state:
$ref: '#/components/schemas/api-shield_api_discovery_state'
api-shield_collection_response_paginated:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/api-shield_api-shield'
api-shield_collection_response:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-collection'
- properties:
result:
type: array
items:
allOf:
- $ref: '#/components/schemas/api-shield_api-shield'
- properties:
features: {}
api-shield_schemas-single_response:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-single'
- properties:
result:
$ref: '#/components/schemas/api-shield_api-shield'
api-shield_operation_schema_validation_settings:
type: object
properties:
mitigation_action:
$ref: '#/components/schemas/api-shield_operation_mitigation_action'
api-shield_schema_response_with_thresholds:
allOf:
- $ref: '#/components/schemas/api-shield_default_response'
- properties:
result:
type: object
properties:
schemas:
type: array
items:
$ref: '#/components/schemas/api-shield_openapiwiththresholds'
timestamp:
type: string
api-shield_zone_schema_validation_settings:
type: object
properties:
validation_default_mitigation_action:
$ref: '#/components/schemas/api-shield_validation_default_mitigation_action'
validation_override_mitigation_action:
$ref: >-
#/components/schemas/api-shield_validation_override_mitigation_action
api-shield_api-response-single:
allOf:
- $ref: '#/components/schemas/api-shield_api-response-common'
- properties:
result:
anyOf:
- type: object
nullable: true
- type: string
nullable: true
type: object
argo-config_response_single:
allOf:
- $ref: '#/components/schemas/argo-config_api-response-single'
- type: object
properties:
result:
type: object
cache_response_single:
allOf:
- $ref: '#/components/schemas/cache_api-response-single'
- type: object
properties:
result:
type: object
bot-management_bot_management_response_body:
allOf:
- $ref: '#/components/schemas/bot-management_api-response-single'
- type: object
properties:
result:
oneOf:
- $ref: '#/components/schemas/bot-management_bot_fight_mode_config'
- $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
- $ref: '#/components/schemas/bot-management_sbfm_likely_config'
- $ref: '#/components/schemas/bot-management_bm_subscription_config'
tls-certificates-and-hostnames_hostname_associations_response:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_hostname_association
tls-certificates-and-hostnames_client_certificate_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_client_certificate
tls-certificates-and-hostnames_client_certificate_response_single:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_client_certificate
tls-certificates-and-hostnames_certificate_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_custom-certificate
tls-certificates-and-hostnames_certificate_response_single:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
type: object
tls-certificates-and-hostnames_certificate_response_id_only:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
type: object
properties:
id:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_identifier
tls-certificates-and-hostnames_custom_hostname_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_custom-hostname
tls-certificates-and-hostnames_custom_hostname_response_single:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_custom-hostname
type: object
tls-certificates-and-hostnames_fallback_origin_response:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
type: object
dns-custom-nameservers_get_response:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- $ref: '#/components/schemas/dns-custom-nameservers_zone_metadata'
dns-custom-nameservers_schemas-empty_response:
allOf:
- $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
- type: object
properties:
result:
type: array
maxItems: 0
items: {}
tls-certificates-and-hostnames_dcv_delegation_response:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_uuidObject
type: object
dns-records_dns_response_collection:
allOf:
- $ref: '#/components/schemas/dns-records_api-response-collection'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/dns-records_dns-record'
dns-records_dns_response_single:
allOf:
- $ref: '#/components/schemas/dns-records_api-response-single'
- type: object
properties:
result:
$ref: '#/components/schemas/dns-records_dns-record'
dns-records_dns_response_import_scan:
allOf:
- $ref: '#/components/schemas/dns-records_api-response-single'
- type: object
properties:
result:
type: object
properties:
recs_added:
type: number
description: Number of DNS records added.
example: 5
total_records_parsed:
type: number
description: Total number of DNS records parsed.
example: 5
timing:
type: object
properties:
end_time:
type: string
format: date-time
description: When the file parsing ended.
example: '2014-03-01T12:20:01Z'
process_time:
type: number
description: Processing time of the file in seconds.
example: 1
start_time:
type: string
format: date-time
description: When the file parsing started.
example: '2014-03-01T12:20:00Z'
dnssec_delete_dnssec_response_single:
allOf:
- $ref: '#/components/schemas/dnssec_api-response-single'
- properties:
result:
type: string
example: ''
dnssec_dnssec_response_single:
allOf:
- $ref: '#/components/schemas/dnssec_api-response-single'
- properties:
result:
$ref: '#/components/schemas/dnssec_dnssec'
legacy-jhs_rule_collection_response:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/legacy-jhs_rule'
legacy-jhs_rule_single_response:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-single'
- properties:
result:
$ref: '#/components/schemas/legacy-jhs_rule'
legacy-jhs_rule_single_id_response:
allOf:
- $ref: '#/components/schemas/legacy-jhs_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: >-
#/components/schemas/legacy-jhs_rule_components-schemas-identifier
waf-managed-rules_rule_group_response_collection:
allOf:
- $ref: '#/components/schemas/waf-managed-rules_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/waf-managed-rules_schemas-group'
waf-managed-rules_rule_group_response_single:
allOf:
- $ref: '#/components/schemas/waf-managed-rules_api-response-single'
- properties:
result:
type: object
waf-managed-rules_rule_response_collection:
allOf:
- $ref: '#/components/schemas/waf-managed-rules_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/waf-managed-rules_rule'
waf-managed-rules_rule_response_single:
allOf:
- $ref: '#/components/schemas/waf-managed-rules_api-response-single'
- properties:
result:
type: object
tls-certificates-and-hostnames_per_hostname_settings_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
properties:
created_at:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at
hostname:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname
status:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status
updated_at:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at
value:
$ref: '#/components/schemas/tls-certificates-and-hostnames_value'
- properties:
result_info:
type: object
properties:
count:
example: 1
page:
example: 1
per_page:
example: 50
total_count:
example: 1
total_pages:
type: number
description: Total pages available of results
example: 1
tls-certificates-and-hostnames_per_hostname_settings_response_delete:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_settingObjectDelete
type: object
tls-certificates-and-hostnames_per_hostname_settings_response:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_settingObject
type: object
tls-certificates-and-hostnames_keyless_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_keyless-certificate
tls-certificates-and-hostnames_keyless_response_single:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
allOf:
- $ref: '#/components/schemas/tls-certificates-and-hostnames_base'
type: object
tls-certificates-and-hostnames_keyless_response_single_id:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
type: object
properties:
id:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_identifier
load-balancing_load-balancer_components-schemas-response_collection:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-collection'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/load-balancing_load-balancer'
load-balancing_load-balancer_components-schemas-single_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
$ref: '#/components/schemas/load-balancing_load-balancer'
load-balancing_components-schemas-id_response:
allOf:
- $ref: '#/components/schemas/load-balancing_api-response-single'
- properties:
result:
type: object
properties:
id:
$ref: >-
#/components/schemas/load-balancing_load-balancer_components-schemas-identifier
logpush_logpush_field_response_collection:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
items:
type: object
nullable: true
properties:
key:
type: string
example: value
logpush_logpush_job_response_collection:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/logpush_logpush_job'
logpush_instant_logs_job_response_collection:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: array
items:
$ref: '#/components/schemas/logpush_instant_logs_job'
logpush_instant_logs_job_response_single:
allOf:
- $ref: '#/components/schemas/logpush_api-response-single'
- properties:
result:
$ref: '#/components/schemas/logpush_instant_logs_job'
logpush_logpush_job_response_single:
allOf:
- $ref: '#/components/schemas/logpush_api-response-single'
- properties:
result:
$ref: '#/components/schemas/logpush_logpush_job'
logpush_get_ownership_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
filename:
type: string
example: logs/challenge-filename.txt
message:
type: string
example: ''
valid:
type: boolean
example: true
logpush_validate_ownership_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
valid:
type: boolean
example: true
logpush_destination_exists_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
exists:
type: boolean
example: false
logpush_validate_response:
allOf:
- $ref: '#/components/schemas/logpush_api-response-common'
- properties:
result:
type: object
nullable: true
properties:
message:
type: string
example: ''
valid:
type: boolean
example: true
tls-certificates-and-hostnames_components-schemas-certificate_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull
tls-certificates-and-hostnames_hostname_aop_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull
tls-certificates-and-hostnames_hostname_aop_single_response:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object
tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-collection
- properties:
result:
type: array
items:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull
tls-certificates-and-hostnames_components-schemas-certificate_response_single:
allOf:
- $ref: >-
#/components/schemas/tls-certificates-and-hostnames_api-response-single
- properties:
result:
$ref: >-
#/components/schemas/tls-certificates-and-hostnames_schemas-certificateObject
tls-certificates-and-hostnames_enabled_response:
allOf:
- $ref: >-
#
# --- truncated at 32 KB (855 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/openapi/cloudflare-zones--openapi-original.yml