openapi: 3.2.0 info: description: Welcome to Cloudflare's API documentation site. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause title: Cloudflare Custom Hostname for a Zone API version: 4.0.0 servers: - description: Client API url: https://api.cloudflare.com/client/v4 security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] tags: - name: Custom Hostname for a Zone paths: /zones/{zone_id}/custom_hostnames: get: operationId: custom-hostname-for-a-zone-list-custom-hostnames summary: List Custom Hostnames description: List, search, sort, and filter all of your custom hostnames. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' - name: hostname in: query schema: description: Fully qualified domain name to match against. This parameter cannot be used with the 'id', 'hostname.exact', 'hostname.contain', or 'hostname.startsWith' parameters. type: string example: app.example.com maxLength: 255 - name: hostname.exact in: query schema: description: Fully qualified domain name to match against. This parameter cannot be used with the 'id', 'hostname', 'hostname.contain', or 'hostname.startsWith' parameters. type: string example: app.example.com maxLength: 255 - name: hostname.startsWith in: query schema: description: Filters hostnames by a prefix match on the hostname value. This parameter cannot be used with the 'id', 'hostname', 'hostname.exact', or 'hostname.contain' parameters. type: string example: app maxLength: 255 - name: hostname.contain in: query schema: description: Filters hostnames by a substring match on the hostname value. This parameter cannot be used with the 'id', 'hostname', 'hostname.exact', or 'hostname.startsWith' parameters. type: string example: example.com maxLength: 255 - name: id in: query schema: description: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname', 'hostname.exact', 'hostname.contain', or 'hostname.startsWith' parameters. type: string example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 maxLength: 36 minLength: 36 - name: page in: query schema: description: Page number of paginated results. type: number default: 1 minimum: 1 - name: per_page in: query schema: description: Number of hostnames per page. type: number default: 20 maximum: 1000 minimum: 5 - name: order in: query schema: description: Field to order hostnames by. type: string example: ssl default: ssl enum: - ssl - ssl_status - name: direction in: query schema: description: Direction to order hostnames. type: string example: desc enum: - asc - desc - name: ssl_status in: query schema: description: Filter by SSL certificate status. type: string example: active enum: - initializing - pending_validation - deleted - pending_issuance - pending_deployment - pending_deletion - pending_expiration - expired - active - initializing_timed_out - validation_timed_out - issuance_timed_out - deployment_timed_out - deletion_timed_out - pending_cleanup - staging_deployment - staging_active - deactivating - inactive - backup_issued - holding_deployment - name: hostname_status in: query schema: description: Filter by the hostname's activation status. type: string example: provisioned enum: - active - pending - active_redeploying - moved - pending_deletion - deleted - pending_blocked - pending_migration - pending_provisioned - test_pending - test_active - test_active_apex - test_blocked - test_failed - provisioned - blocked - name: certificate_authority in: query schema: description: Filter by the certificate authority that issued the SSL certificate. type: string example: google enum: - google - lets_encrypt - ssl_com - name: wildcard in: query schema: description: Filter by whether the custom hostname is a wildcard hostname. type: boolean example: false - name: custom_origin_server in: query schema: description: Filter by custom origin server name. type: string example: origin2.example.com - name: ssl in: query schema: description: Whether to filter hostnames based on if they have SSL enabled. type: integer default: 0 enum: - 0 - 1 responses: '200': description: List Custom Hostnames response. content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection' 4XX: description: List Custom Hostnames response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write - SSL and Certificates Read x-cfPermissionsRequired: enum: - '#ssl:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames x-fern-sdk-method-name: list x-forge-hidden: true post: operationId: custom-hostname-for-a-zone-create-custom-hostname summary: Create Custom Hostname description: Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation). Enable bundling of certificates using the custom_cert_bundle field. The bundling process requires the following condition One certificate in the bundle must use an RSA, and the other must use an ECDSA. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object properties: custom_metadata: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata' custom_origin_server: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server' custom_origin_sni: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_post' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslpost' required: - hostname responses: '200': description: Create Custom Hostname response. content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' 4XX: description: Create Custom Hostname response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write x-cfPermissionsRequired: enum: - '#ssl:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames x-fern-sdk-method-name: create x-forge-hidden: true /zones/{zone_id}/custom_hostnames/quota: get: operationId: custom-hostname-for-a-zone-get-custom-hostname-quota summary: Get Custom Hostname Quota description: Returns custom hostname quota usage for a zone. The allocated quota is a soft limit; creating custom hostnames after usage exceeds this limit can still succeed until the hard cap is reached. Use the exceeded and hard_cap fields to track when usage is above the soft limit and when new custom hostname creation will be rejected. parameters: - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: '200': description: Get Custom Hostname Quota response content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_quota_response' 4XX: description: Get Custom Hostname Quota response failure content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_api_response_failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write - SSL and Certificates Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames.quota x-fern-sdk-method-name: get x-forge-hidden: true /zones/{zone_id}/custom_hostnames/{custom_hostname_id}: delete: operationId: custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates) summary: Delete Custom Hostname (and any issued SSL certificates) description: Permanently deletes a custom hostname and revokes any SSL certificates that were issued for it. This action cannot be undone. parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: '200': description: Delete Custom Hostname (and any issued SSL certificates) response. content: application/json: schema: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' 4XX: description: Delete Custom Hostname (and any issued SSL certificates) response failure. content: application/json: schema: allOf: - properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' type: object - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write x-cfPermissionsRequired: enum: - '#ssl:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: custom-hostname-for-a-zone-custom-hostname-details summary: Custom Hostname Details description: Retrieves detailed information about a specific custom hostname, including SSL certificate status, ownership verification, and origin configuration. parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: '200': description: Custom Hostname Details response. content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' 4XX: description: Custom Hostname Details response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write - SSL and Certificates Read x-cfPermissionsRequired: enum: - '#ssl:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: custom-hostname-for-a-zone-edit-custom-hostname summary: Edit Custom Hostname description: Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'. Bundle an existing certificate with another certificate by using the "custom_cert_bundle" field. The bundling process supports combining certificates as long as the following condition is met. One certificate must use the RSA algorithm, and the other must use the ECDSA algorithm. parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: type: object properties: custom_metadata: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata' custom_origin_server: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server' custom_origin_sni: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslpost' responses: '200': description: Edit Custom Hostname response. content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' 4XX: description: Edit Custom Hostname response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write x-cfPermissionsRequired: enum: - '#ssl:edit' x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames x-fern-sdk-method-name: edit x-forge-hidden: true ? /zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id} : delete: operationId: custom-hostname-for-a-zone-delete_single_certificate_and_key_in_a_custom_hostname summary: Delete Single Certificate And Key For Custom Hostname description: Delete a single custom certificate from a certificate pack that contains two bundled certificates. Deletion is subject to the following constraints. You cannot delete a certificate if it is the only remaining certificate in the pack. At least one certificate must remain in the pack. parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: certificate_pack_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' responses: '202': description: Delete Single Certificate and Key In a Custom Hostname response. content: application/json: schema: type: object properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' 4XX: description: Delete Single Certificate and Key In a Custom Hostname response failure. content: application/json: schema: allOf: - properties: id: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' type: object - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames.certificate-pack.certificates x-fern-sdk-method-name: delete x-forge-hidden: true put: operationId: custom-hostname-for-a-zone-edit-custom-certificate-custom-hostname summary: Replace Custom Certificate and Custom Key In Custom Hostname description: Replace a single custom certificate within a certificate pack that contains two bundled certificates. The replacement must adhere to the following constraints. You can only replace an RSA certificate with another RSA certificate or an ECDSA certificate with another ECDSA certificate. parameters: - name: custom_hostname_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: certificate_pack_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: certificate_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' - name: zone_id in: path required: true schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_cert_and_key' responses: '202': description: Edit Custom Certificate In a Custom Hostname response. content: application/json: schema: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' 4XX: description: Edit Custom Certificate In a Custom Hostname response failure. content: application/json: schema: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single' - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Custom Hostname for a Zone x-api-token-group: - SSL and Certificates Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true x-fern-availability: generally-available x-fern-sdk-group-name: custom-hostnames.certificate-pack.certificates x-fern-sdk-method-name: update x-forge-hidden: true components: schemas: tls-certificates-and-hostnames_verification_errors: description: These are errors that were encountered while trying to activate a hostname. type: array items: type: string x-auditable: true example: - None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found. tls-certificates-and-hostnames_created_at: description: This is the time the hostname was created. type: string format: date-time example: '2020-02-06T18:11:23.531995Z' x-auditable: true tls-certificates-and-hostnames_identifier: description: Identifier. type: string example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 x-auditable: true tls-certificates-and-hostnames_validation_record: description: Certificate's required validation record. type: object properties: cname: description: The CNAME record hostname for DCV delegation. type: string example: _acme-challenge.example.com readOnly: true x-auditable: true cname_target: description: The CNAME record target value for DCV delegation. type: string example: dcv.cloudflare.com readOnly: true x-auditable: true emails: description: The set of email addresses that the certificate authority (CA) will use to complete domain validation. type: array items: type: string x-auditable: true example: - administrator@example.com - webmaster@example.com http_body: description: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation. type: string example: ca3-574923932a82475cb8592200f1a2a23d http_url: description: The url that will be checked during domain validation. type: string example: http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt status: description: Status of the validation record. type: string example: pending readOnly: true txt_name: description: The hostname that the certificate authority (CA) will check for a TXT record during domain validation . type: string example: _acme-challenge.app.example.com x-auditable: true txt_value: description: The TXT record that the certificate authority (CA) will check during domain validation. type: string example: 810b7d5f01154524b961ba0cd578acc2 tls-certificates-and-hostnames_custom_cert_and_key: type: object properties: custom_certificate: description: If a custom uploaded certificate is used. type: string example: '-----BEGIN CERTIFICATE----- MIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx... -----END CERTIFICATE----- ' custom_key: description: The key for a custom uploaded certificate. type: string example: '-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5... -----END PRIVATE KEY----- ' x-sensitive: true required: - custom_certificate - custom_key tls-certificates-and-hostnames_sslpost: description: SSL properties used when creating the custom hostname. type: object oneOf: - properties: bundle_method: description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. type: string example: ubiquitous default: ubiquitous enum: - ubiquitous - optimal - force x-auditable: true certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority' cloudflare_branding: description: Whether or not to add Cloudflare Branding for the order. This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true. type: boolean example: false x-auditable: true custom_cert_bundle: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_cert_bundle' custom_certificate: description: If a custom uploaded certificate is used. type: string example: '-----BEGIN CERTIFICATE----- MIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O OeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7 -----END CERTIFICATE----- ' x-auditable: true custom_csr_id: description: The identifier for the Custom CSR that was used. type: string example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 x-auditable: true custom_key: description: The key for a custom uploaded certificate. type: string example: '-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi -----END RSA PRIVATE KEY----- ' x-sensitive: true method: description: Domain control validation (DCV) method used for this hostname. type: string example: http enum: - http - txt - email x-auditable: true settings: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings' type: description: Level of validation to be used for this hostname. Domain validation (dv) must be used. type: string example: dv enum: - dv x-auditable: true wildcard: description: Indicates whether the certificate covers a wildcard. type: boolean example: false x-auditable: true type: object tls-certificates-and-hostnames_custom_metadata: description: Unique key/value metadata for this hostname. These are per-hostname (customer) settings. type: object additionalProperties: type: string x-auditable: true tls-certificates-and-hostnames_custom_origin_sni: description: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server. type: string example: sni.example.com x-auditable: true tls-certificates-and-hostnames_custom_hostname_quota_response: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_api_response_common' - properties: result: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_quota' type: object tls-certificates-and-hostnames_messages: type: array items: properties: code: type: integer minimum: 1000 documentation_url: type: string message: type: string source: type: object properties: pointer: type: string required: - code - message type: object uniqueItems: true example: [] tls-certificates-and-hostnames_customhostname: type: object properties: created_at: $ref: '#/components/schemas/tls-certificates-and-hostnames_created_at' custom_metadata: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata' custom_origin_server: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server' custom_origin_sni: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni' hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' ownership_verification: $ref: '#/components/schemas/tls-certificates-and-hostnames_ownership_verification' ownership_verification_http: $ref: '#/components/schemas/tls-certificates-and-hostnames_ownership_verification_http' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl' status: $ref: '#/components/schemas/tls-certificates-and-hostnames_status-3' verification_errors: $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_errors' tls-certificates-and-hostnames_custom_hostname_response_single: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_api_response_common' - properties: result: type: object allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname' type: object tls-certificates-and-hostnames_api-response-common-failure: type: object properties: errors: example: - code: 7003 message: No route for the URI allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' minLength: 1 messages: example: [] allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' result: type: - object - 'null' enum: - null success: description: Whether the API call was successful. type: boolean example: false enum: - false required: - success - errors - messages - result tls-certificates-and-hostnames_result_info: type: object properties: count: description: Total number of results for the requested service. type: number example: 1 page: description: Current page within paginated list of results. type: number example: 1 per_page: description: Number of results per page of results. type: number example: 20 total_count: description: Total results available without any search parameters. type: number example: 2000 total_pages: description: The number of total pages in the entire result set. type: number example: 100 tls-certificates-and-hostnames_custom-hostname: type: object properties: hostname: $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname' id: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_identifier' ssl: $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl' allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_customhostname' required: - id - hostname tls-certificates-and-hostnames_status-3: description: Status of the hostname's activation. type: string example: pending enum: - active - pending - active_redeploying - moved - pending_deletion - deleted - pending_blocked - pending_migration - pending_provisioned - test_pending - test_active - test_active_apex - test_blocked - test_failed - provisioned - blocked x-auditable: true tls-certificates-and-hostnames_custom_hostname_api_response_failure: type: object properties: errors: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' - example: - code: 7003 message: No route for the URI items: type: object minItems: 1 type: array messages: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_messages' result: type: - object - 'null' enum: - null success: description: Whether the API call was successful. type: boolean example: false enum: - false required: - success - errors - messages - result tls-certificates-and-hostnames_custom_hostname_response_collection: allOf: - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_api_response_common' - properties: result: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname' result_info: $ref: '#/components/schemas/tls-certificates-and-hostnames_result_info' type: object tls-certificates-and-hostnames_sslsettings: description: SSL specific settings. type: object properties: ciphers: description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format. type: array items: type: string x-auditable: true example: - ECDHE-RSA-AES128-GCM-SHA256 - AES128-SHA uniqueItems: true early_hints: description: Whether or not Early Hints is enabled. type: string example: 'on' enum: - 'on' - 'off' x-auditable: true http2: description: Whether or not HTTP2 is enabled. type: string example: 'on' enum: - 'on' - 'off' x-auditable: true min_tls_version: description: The minimum TLS version supported. type: string example: '1.2' enum: - '1.0' - '1.1' - '1.2' - '1.3' x-auditable: true tls_1_3: description: Whether or not TLS 1.3 is enabled. type: string example: 'on' enum: - 'on' - 'off' x-auditable: true tls-certificates-and-hostnames_ownership_verification: description: This is a record which can be placed to activate a hostname. type: object oneOf: - properties: name: description: DNS Name for record. type: string example: _cf-custom-hostname.app.example.com x-auditable: true type: description: DNS Record type. type: string example: txt enum: - txt x-auditable: true value: description: Content for the record. type: string example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 type: object tls-certificates-and-hostnames_hostname: description: The custom hostname that will point to your hostname via CNAME. type: string example: app.example.com maxLength: 255 readOnly: true x-auditable: true tls-certificates-and-hostnames_certificate_authority: description: The Certificate Authority that will issue the certificate. type: string example: google enum: - digicert - google - lets_encrypt - ssl_com x-auditable: true tls-certificates-and-hostnames_ownership_verification_http: description: This presents the token to be served by the given http url to activate a hostname. type: object oneOf: - properties: http_body: description: Token to be served. type: string example: 5cc07c04-ea62-4a5a-95f0-419334a875a4 http_url: description: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token. type: string example: http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9 type: object tls-certificates-and-hostnames_custom_hostname_api_response_common: type: object properties: errors: $ref: '#/components/schemas/tls-certificates-and-hostnames_messages' messages: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_messages' success: description: Whether the API call was successful. type: boolean example: true enum: - true required: - success - errors - messages tls-certificates-and-hostnames_hostname_post: description: The custom hostname that will point to your hostname via CNAME. type: string example: app.example.com maxLength: 255 x-auditable: true tls-certificates-and-hostnames_custom_hostname_quota: type: object properties: allocated: description: The allocated custom hostname quota. type: integer format: int64 example: 100 x-auditable: true exceeded: description: Whether the current usage has exceeded the allocated quota. type: boolean example: false x-auditable: true hard_cap: description: The maximum number of custom hostnames allowed before create requests are rejected. type: integer format: int64 example: 200 x-auditable: true used: description: The number of custom hostnames currently in use. type: integer format: int64 example: 50 x-auditable: true required: - allocated - used - exceeded - hard_cap tls-certificates-and-hostnames_ssl: description: SSL properties for the custom hostname. type: object oneOf: - properties: bundle_method: description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. type: string example: ubiquitous default: ubiquitous enum: - ubiquitous - optimal - force x-auditable: true certificate_authority: $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority' custom_certificate: description: If a custom uploaded certificate is used. type: string example: '-----BEGIN CERTIFICATE----- MIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O OeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7 -----END CERTIFICATE----- ' custom_csr_id: description: The identifier for the Custom CSR that was used. type: string example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752 x-auditable: true custom_key: description: The key for a custom uploaded certificate. type: string example: '-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/ axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7 9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9 N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR 9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7 mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi -----END RSA PRIVATE KEY----- ' x-sensitive: true dcv_delegation_records: description: DCV Delegation records for domain validation. type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_record' readOnly: true expires_on: description: The time the custom certificate expires on. type: string format: date-time example: '2021-02-06T18:11:23.531995Z' x-auditable: true hosts: description: A list of Hostnames on a custom uploaded certificate. type: array items: type: string x-auditable: true example: - app.example.com - '*.app.example.com' id: description: Custom hostname SSL identifier tag. type: string example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 maxLength: 36 minLength: 36 x-auditable: true issuer: description: The issuer on a custom uploaded certificate. type: string example: DigiCertInc x-auditable: true method: description: Domain control validation (DCV) method used for this hostname. type: string example: txt enum: - http - txt - email readOnly: true x-auditable: true serial_number: description: The serial number on a custom uploaded certificate. type: string example: '6743787633689793699141714808227354901' x-auditable: true settings: $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings' signature: description: The signature on a custom uploaded certificate. type: string example: SHA256WithRSA x-auditable: true status: description: Status of the hostname's SSL certificates. type: string example: pending_validation enum: - initializing - pending_validation - deleted - pending_issuance - pending_deployment - pending_deletion - pending_expiration - expired - active - initializing_timed_out - validation_timed_out - issuance_timed_out - deployment_timed_out - deletion_timed_out - pending_cleanup - staging_deployment - staging_active - deactivating - inactive - backup_issued - holding_deployment readOnly: true x-auditable: true type: description: Level of validation to be used for this hostname. Domain validation (dv) must be used. type: string example: dv enum: - dv x-auditable: true uploaded_on: description: The time the custom certificate was uploaded. type: string format: date-time example: '2020-02-06T18:11:23.531995Z' x-auditable: true validation_errors: description: Domain validation errors that have been received by the certificate authority (CA). type: array items: properties: message: description: A domain validation error. type: string example: SERVFAIL looking up CAA for app.example.com x-auditable: true type: object validation_records: type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_record' wildcard: description: Indicates whether the certificate covers a wildcard. type: boolean example: false x-auditable: true type: object tls-certificates-and-hostnames_custom_hostname_response_messages: description: Informational messages returned by the custom hostname API. type: array items: type: string x-auditable: true example: [] tls-certificates-and-hostnames_custom_cert_bundle: description: Array of custom certificate and key pairs (1 or 2 pairs allowed). type: array items: $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_cert_and_key' maxItems: 2 minItems: 1 tls-certificates-and-hostnames_custom_origin_server: description: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. type: string example: origin2.example.com x-auditable: true tls-certificates-and-hostnames_custom_hostname_identifier: description: Custom hostname identifier tag. type: string example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9 maxLength: 36 minLength: 36 readOnly: true x-auditable: true securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey api_key: in: header name: X-Auth-Key type: apiKey api_token: scheme: bearer type: http user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey externalDocs: description: Cloudflare Radar Documentation url: https://developers.cloudflare.com/radar/ x-forge-commands: abuse-reports: description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites groups: appeals: description: Appeal eligibility for abuse reports emails: description: Emails sent for abuse reports mitigations: description: Mitigation actions taken in response to abuse reports accounts: description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account groups: applications: description: Applications operations categories: description: Categories operations organizations: description: Move accounts between organizations profile: description: View and manage the profile for a Cloudflare account roles: description: View the roles available for assigning to account members, each defining a set of permissions subscriptions: description: View and manage plan subscriptions attached to this account tokens: description: Create and manage scoped API tokens for programmatic access to the Cloudflare API ai-gateway: description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more groups: custom-domains: description: Manage custom hostnames that route requests through an AI Gateway custom-providers: description: Manage account-level custom AI providers and their endpoint settings datasets: description: 'Deprecated: manage filtered collections of gateway logs used by evaluations' dynamic-routing: description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments dynamic-routing.deployments: description: Deploy dynamic route versions and view deployment history dynamic-routing.versions: description: Create and inspect saved versions of a dynamic route evaluation-types: description: 'Deprecated: list the evaluator types that evaluations can use' evaluations: description: 'Deprecated: score the logs in a dataset with selected evaluator types' gateways: description: Create and configure AI Gateways for an account gateways.providers: description: Store and rotate upstream AI provider keys for a gateway logs: description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs ai-search: description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions' groups: items: description: Content indexed by AI Search instances jobs: description: Indexing job lifecycle for AI Search instances namespace: description: Logical groupings for organizing AI Search instances tokens: description: Credentials used by AI Search instances ai-security: description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications groups: custom-topics: description: Organization-specific topic categories used by AI Security for Apps content detection analytics: description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics groups: colo: description: Per-data-center (colo) traffic analytics breakdown for the zone dashboard: description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views latency: description: Argo Smart Routing latency analytics showing time-to-first-byte improvements argo: description: Network optimization features that speed up and improve reliability of traffic to your origins groups: smart-routing: description: Route traffic through the fastest network paths to your origin using real-time latency data tiered-caching: description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin basin-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables billing: description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services groups: profiles: description: Billing profile with payment method, address, and invoice preferences usage: description: Metered usage data for billed services — requests, bandwidth, and feature consumption botnet-feed: description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure groups: asn: description: ASN-level botnet activity data showing networks with known C2 infrastructure configs: description: Botnet feed subscription configuration and notification preferences builds: description: Build and deploy Workers from connected repositories, then inspect build status and logs. groups: deploy-hooks: description: Manage branch-specific HTTP hooks that start builds. limits: description: View build-minute availability and refresh information. logs: description: Retrieve build logs. repos: description: Manage source repository connections for Workers Builds. tokens: description: Manage credentials used by Workers Builds to deploy Workers. triggers: description: Configure how repository changes build and deploy Workers. versions: description: Find builds associated with Worker versions. workers: description: Manage repository-backed build configuration for Workers. cache: description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving groups: origin-cloud-regions: description: Manage Origin Cloud Regions routing and failover configurations settings: description: Configure Cache Reserve, tiered caching, and variant serving settings.regional-tiered-cache: description: Restrict tiered cache topology to data centers within a specific geographic region settings.reserve: description: Persistent storage tier that keeps cached assets even after eviction from edge caches settings.smart-tiered-cache: description: Automatically determine the best upper-tier data centers for tiered cache topology settings.variants: description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.) client-side-security: description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks groups: connections: description: Third-party connections made by scripts on your pages — track data exfiltration risks cookies: description: Cookies set by your pages with classification and same-site attribute tracking policies: description: Content Security Policies that control which scripts and connections are allowed on your pages scripts: description: JavaScript files detected on your pages with change tracking and malicious code detection settings: description: Fine tune Client-Side Security behaviors cloud-connector: description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers groups: rules: description: Routing rules that map request patterns to cloud provider endpoints cloudforce-one: description: Detection rule management APIs groups: binary-storage: description: Upload and retrieve malware samples and suspicious binaries for analysis requests: description: Additional request operations — priority listing and asset creation rules: description: Rule management operations groups: approvals: description: Approval workflow operations email: description: Email rule operations exemptions: description: Exemption rule operations managed: description: Managed rule operations stats: description: Rule statistics operations tree: description: Rule navigation tree operations scans: description: Scan URLs, IPs, and domains for threat intelligence indicators containers: description: Deploy and manage Containers applications on Cloudflare's global network groups: applications: description: Manage Containers applications applications.instances: description: Inspect Containers instances belonging to applications applications.rollouts: description: Manage rollouts for scheduler-backed applications applications.versions: description: Inspect versions of scheduler-backed applications registries: description: Manage Containers image registries registries.credentials: description: Generate image registry credentials content-scan: description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads groups: expressions: description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own custom-pages: description: Manage custom error and challenge pages and their assets for accounts and zones groups: account-custom-pages: description: Manage account-level custom pages account-custom-pages.preview-tokens: description: Preview tokens for account-level custom pages assets: description: Manage account- and zone-level custom assets zone-custom-pages: description: Manage zone-level custom pages zone-custom-pages.preview-tokens: description: Preview tokens for zone-level custom pages d1: description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access. groups: time-travel: description: use specific point-in-time backups of your D1 database x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel diagnostics: description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks groups: endpoint-healthchecks: description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks traceroutes: description: Run traceroutes from Cloudflare data centers to diagnose network path issues email-routing: description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records groups: addresses: description: Verified destination email addresses that can receive forwarded mail dns: description: Inspect or unlock the DNS records required by Email Routing rules: description: Match incoming email addresses and forward messages to destination mailboxes or Workers settings: description: Inspect and update Email Routing settings email-security: description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing groups: analytics: description: Analytics and reporting — monthly report and per-day breakdowns of threat activity bulk-actions: description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs investigate: description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions phishguard: description: PhishGuard user-reported phishing reports — view detected threats for a date range settings: description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling submissions: description: Reclassify submissions — track user and team reports of false positives and missed detections email-sending: description: Send transactional email and manage sending subdomains and their DNS configuration groups: limits: description: Inspect account-level sending quotas and current usage subdomains: description: Configure sending subdomains and keep their DNS records healthy suppressions: description: Prevent delivery to suppressed addresses and manage the account suppression list filters: description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations firewall: description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages groups: access-rules: description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone lockdowns: description: Zone lockdown rules that restrict access to URLs by IP address or range rules: description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations ua-rules: description: Block or challenge requests based on the User-Agent header string waf: description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations zone-access-rules: description: Zone-scoped IP access rules for blocking or allowing traffic google-tag-gateway: description: Google Tag Gateway operations groups: config: description: Google Tag Gateway config operations healthchecks: description: Standalone health checks that monitor origin server availability from Cloudflare's edge groups: previews: description: Test a health check configuration before deploying it to production hyperdrive: description: Accelerate access to existing databases by caching queries and pooling connections at the edge iam: description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors groups: permission-groups: description: View the permission groups that can be assigned to API tokens and policies resource-groups: description: Define scopes that limit which account resources a policy or token can access sso: description: Configure single sign-on connectors to authenticate account members through an external identity provider user-groups: description: Organize account members into groups for easier permission assignment images: description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads groups: flows: description: Zone-level transformation flows that control how images are resized and optimized on delivery import: description: Import images from S3 keys: description: Manage signing keys for generating private image URLs variants: description: Manage named resize variants for transforming images on delivery intel: description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds groups: asn: description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems attack-surface-report: description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping dns: description: Passive DNS data showing historical DNS resolution records for domains domain-history: description: Historical domain registration and categorization changes over time domains: description: Domain intelligence — risk scores, categories, and associated infrastructure indicator-feeds: description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs ip-lists: description: Curated IP lists used for threat detection and policy enforcement ips: description: IP address intelligence — geolocation, risk assessment, and hosting provider details miscategorizations: description: Report and track domain miscategorization corrections whois: description: WHOIS registration data for domains including registrant, registrar, and nameservers k2: description: Durable, ordered event streams that you produce records to and consume from with subscriptions groups: streams: description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records streams.subscriptions: description: Subscriptions that consume a K2 stream, with committed-position lag leaked-credential-checks: description: Detect compromised credentials in login requests by checking against known breach databases groups: detections: description: Custom detection locations that tell the WAF where to find usernames and passwords in requests load-balancers: description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover groups: monitor-groups: description: Group monitors together for shared configuration and bulk management monitor-groups.references: description: List references to monitor groups used by load balancer pools monitors: description: Health check configurations that probe origin servers and determine pool availability monitors.previews: description: Health check configurations that probe origin servers and determine pool availability monitors.references: description: Health check configurations that probe origin servers and determine pool availability pools: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.health: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.references: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences previews: description: Preview the result of a health check monitor configuration before applying it regions: description: Geographic regions used for regional pool steering and traffic policies searches: description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference logs: description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields groups: control: description: Log control operations received: description: Received log operations magic-network-monitoring: description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion groups: configs: description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings rules: description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements vpc-flows: description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection magic-transit: description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures groups: advanced-dns-protection: description: Advanced Dns Protection operations advanced-tcp-protection: description: Advanced Tcp Protection operations apps: description: Application-aware traffic policies for Magic WAN that steer traffic by app type bgp-filter-profiles: description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels bgp-settings: description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels cf-interconnects: description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering gre-tunnels: description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit ipsec-tunnels: description: IPsec tunnel endpoints with pre-shared key management for encrypted transit pcaps: description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels routes: description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels sites: description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config mcp: description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls groups: portals: description: Manage MCP portals, attached servers, and Code Mode settings servers: description: Manage upstream MCP servers, credentials, capabilities, and sync state network-interconnects: description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network groups: cnis: description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare interconnects: description: Physical cross-connect and partner interconnect sessions with LOA and status tracking settings: description: Account-level interconnect settings and default configurations slots: description: Available interconnect facility slots showing port capacity at Cloudflare data centers organizations: description: Multi-user organizations that group accounts, members, and shared settings under a single entity groups: account-organizations: description: List organizations associated with a specific account accounts: description: Accounts operations members: description: Members operations members-batch-create: description: Members Batch Create operations organization-profile: description: View and update the public profile information for an organization shares: description: Shares operations origin-post-quantum-encryption: description: Enable post-quantum key exchange for connections between Cloudflare and your origin server pages: description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains groups: projects: description: Pages projects, deployments, build logs, and custom domain bindings pipelines: description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time groups: sinks: description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage streams: description: Inbound data streams that feed events into a pipeline for processing precursor: description: Precursor settings for a zone queues: description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale groups: consumers: description: Workers that automatically receive and process messages from a queue messages: description: Push messages to a queue and pull or acknowledge them from consumers purge: description: Remove all pending messages from a queue subscriptions: description: Manage queue subscriptions for event-driven message routing r2: description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration groups: buckets: description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks buckets.jobs: description: Create and inspect background jobs for an R2 bucket buckets.local-uploads: description: R2 bucket local upload configuration super-slurper: description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs temporary-credentials: description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations r2-data-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables radar: description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights groups: agent-readiness: description: Agent readiness summary statistics across the Cloudflare network ai: description: AI inference trends and model usage statistics across the Cloudflare network annotations: description: Radar annotations marking significant Internet events (outages, cable cuts, etc.) as112: description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space attacks: description: DDoS and application-layer attack trends, vectors, and target analysis bgp: description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events bots: description: Internet-wide bot traffic trends, categories, and distribution statistics ct: description: Certificate Transparency log monitoring and newly-issued certificate discovery datasets: description: Downloadable Radar datasets for offline analysis and research dns: description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption email: description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics entities: description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries geolocations: description: Geographic location metadata used for regional traffic analysis http: description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution leaked-credentials: description: Leaked credential detection trends and exposure statistics netflows: description: Network-layer traffic flow data and volumetric trend analysis origins: description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics post-quantum: description: Post-quantum encryption adoption and deployment trends across the Internet quality: description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN ranking: description: Top domain rankings based on DNS query popularity across the Cloudflare network robots-txt: description: Robots.txt adoption and crawler directive trends across the web search: description: Search Radar data across IPs, ASNs, domains, and locations tcp-resets-timeouts: description: TCP connection reset and timeout statistics indicating network health issues tlds: description: Top-level domain (TLD) metadata and performance trends traffic-anomalies: description: Detected traffic anomalies and unusual patterns in Internet traffic flows verified-bots: description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns rate-limits: description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations realtime: description: Real-time audio, video, and data services on Cloudflare's global network groups: kit: description: SDK-backed meetings, participants, recordings, livestreams, and webhooks kit.analytics: description: Usage and livestream analytics for RealtimeKit applications kit.analytics.livestreams: description: Livestream analytics for RealtimeKit applications kit.analytics.livestreams.daily: description: Daily livestream analytics for RealtimeKit applications kit.analytics.usage: description: Usage analytics for RealtimeKit applications kit.apps: description: RealtimeKit applications that group meetings, sessions, and configuration kit.livestreams: description: Independent and meeting-based livestreams and their sessions kit.livestreams.sessions: description: Sessions for RealtimeKit livestreams kit.meetings: description: Meetings, participants, access tokens, and meeting livestreams kit.meetings.active: description: Live meeting state and participant controls kit.meetings.active.polls: description: Polls for active meeting sessions kit.meetings.livestream: description: Livestream operations associated with RealtimeKit meetings kit.meetings.participants: description: Participants in RealtimeKit meetings kit.meetings.participants.tokens: description: Access tokens for RealtimeKit meeting participants kit.presets: description: Reusable meeting configuration for media, permissions, and interface behavior kit.recordings: description: Meeting and participant-track recordings and recording controls kit.recordings.active: description: Active recordings for RealtimeKit meetings kit.recordings.tracks: description: Participant-track recordings for RealtimeKit meetings kit.sessions: description: Historical session data, participants, chat, transcripts, and summaries kit.sessions.chat: description: Chat messages from historical RealtimeKit sessions kit.sessions.livestreams: description: Livestreams associated with historical RealtimeKit sessions kit.sessions.participants: description: Participants in historical RealtimeKit sessions kit.sessions.peers: description: Peer details from historical RealtimeKit sessions kit.sessions.summaries: description: Summaries of historical RealtimeKit sessions kit.sessions.transcripts: description: Transcripts from historical RealtimeKit sessions kit.webhooks: description: Webhook endpoints and supported events for RealtimeKit notifications kit.webhooks.events: description: Supported events for RealtimeKit webhooks moq: description: MoQ relays for publishing and subscribing to media streams moq.relays: description: Relays are isolated MoQ scopes that carry media between publishers and subscribers moq.relays.tokens: description: Tokens that authorize publishers and subscribers to connect to a relay sfu: description: SFU apps that route WebRTC media and data between participants sfu.apps: description: SFU application namespaces for sessions and tracks turn: description: TURN keys that help clients traverse NATs and firewalls turn.keys: description: Keys used to generate short-lived TURN credentials request-tracers: description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline groups: traces: description: Simulate request processing to debug rule matches, transforms, and routing decisions resource-sharing: description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls groups: recipients: description: Update share recipients resources: description: Individual resources (zones, configs) that have been shared with recipients rules: description: Resources used by Cloudflare rules and rulesets groups: lists: description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions rum: description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics groups: rules: description: Rules that control which pages and paths are tracked by Web Analytics site-info: description: Web Analytics sites — register domains and get the JavaScript beacon snippet scim: description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account groups: groups: description: Groups operations resource-types: description: Resource Types operations schemas: description: Schemas operations service-provider-config: description: Service Provider Config operations users: description: Users operations secrets-store: description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products groups: quota: description: Account quota limits for secrets stores, secrets count, and storage capacity secrets: description: Encrypted key-value secrets within a store. Pass --store-id to scope. stores: description: Secret stores that hold encrypted key-value secrets accessible by Workers and services security-center: description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities groups: insights: description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc. zone-insights: description: Zone-scoped security insights — counts by class, severity, type, and dismissal security-txt: description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities smart-shield: description: Smart Shield settings, health checks, and cache reserve management groups: cache-reserve-clear: description: Cache Reserve Clear operations health-checks: description: Health checks operations spectrum: description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation groups: analytics: description: Real-time and historical connection analytics for Spectrum applications apps: description: Spectrum application configurations that map protocols and ports to origin servers speed: description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests groups: availabilities: description: Check which speed test regions and configurations are available for your zone pages: description: Tested pages with their performance history, trends, and individual test results schedule: description: Scheduled recurring speed tests that automatically run at regular intervals ssl: description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations groups: automatic-upgrader: description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings recommendations: description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration stream: description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale groups: audio-tracks: description: Add, edit, or remove additional audio tracks on a video captions: description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages clip: description: Create a new video clip from an existing video by specifying start and end times copy: description: Import a video from a URL into Stream for processing and delivery direct-upload: description: Generate a tokenized URL that lets end-users upload video directly to Stream downloads: description: Create downloadable MP4 renditions of a video for offline viewing embed: description: Retrieve the HTML embed code snippet for a video keys: description: Signing keys used to generate short-lived signed URLs for private video playback live-inputs: description: Enable and disable live input streams token: description: Generate short-lived signed URL tokens for secure private video playback typed-downloads: description: Type-specific stream download creation and deletion videos: description: Aggregate video storage usage statistics for the account watermarks: description: Watermark profiles that overlay an image on every video in the account webhooks: description: Webhook notifications for video lifecycle events (ready, error, etc.) tenants: description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships groups: account-types: description: Account Types operations accounts: description: Accounts operations entitlements: description: Entitlements operations memberships: description: Memberships operations turnstile: description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience groups: widgets: description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings url-scanner: description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results groups: response: description: Response operations responses: description: Raw HTTP response data captured during URL scans scan: description: Scan operations scans: description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts user: description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens groups: billing: description: View billing history and payment profile for your user (deprecated — prefer account-level billing) firewall: description: Firewall operations load-balancers.monitors: description: Load Balancers operations load-balancers.monitors.preview: description: Load Balancers operations load-balancers.monitors.references: description: Load Balancers operations load-balancers.pools: description: Load Balancers operations load-balancers.pools.edit.pools: description: Load Balancers operations load-balancers.pools.health: description: Load Balancers operations load-balancers.pools.preview: description: Load Balancers operations load-balancers.pools.references: description: Load Balancers operations load-balancers.preview: description: Load Balancers operations load-balancing-analytics.events: description: Load Balancing Analytics operations subscriptions: description: View and manage zone-level plan subscriptions owned by your user tenants: description: Tenants operations tokens: description: Create and manage personal API tokens scoped to your user for programmatic API access user.analytics: description: User-level traffic analytics — aggregated totals and timeseries across all zones vectorize: description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers groups: deprecated-indexes: description: Deprecated v1 Vectorize index operations metadata-index: description: Metadata indexes for filtered vector search waiting-rooms: description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages groups: account-waiting-rooms: description: Account-scoped waiting room listing events: description: Scheduled events that temporarily override waiting room settings for sales, launches, etc. page: description: Custom HTML waiting page templates and preview rendering rules: description: Rules that bypass or modify waiting room behavior for specific request patterns settings: description: Zone-level waiting room defaults and cookie configuration statuses: description: Real-time queue status showing active users, queued users, and estimated wait times workflows: description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence groups: instances: description: Workflow instance operations versions: description: Workflow version operations zaraz: description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS groups: config: description: Full Zaraz configuration including tools, triggers, and variables for the zone default: description: Default Zaraz configuration template used as a starting point for new zones export: description: Export the current Zaraz configuration as a portable JSON document history: description: Configuration version history — browse and restore previous Zaraz configurations publish: description: Publish pending Zaraz configuration changes to make them live on the zone workflow: description: Workflow state for Zaraz configuration changes (draft vs. published) zero-trust: description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation groups: dex: description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics dlp.custom-prompt-topics: description: Data Loss Prevention - manage custom prompt topics for AI-based content detection dlp.data-classes: description: Data Loss Prevention - manage data classes used to classify sensitive information dlp.data-tag-categories: description: Data Loss Prevention - manage categories that organize data tags dlp.data-tag-category-templates: description: Data Loss Prevention - browse templates for creating data tag categories dlp.data-tags: description: Data Loss Prevention - manage tags used to classify and organize sensitive data dlp.datasets: description: Data Loss Prevention - manage datasets, versions, and uploads dlp.document-fingerprints: description: Data Loss Prevention - manage document fingerprints for detecting matching documents dlp.email.account-mapping: description: Data Loss Prevention - configure account mappings for outbound email scanning dlp.email.rules: description: Data Loss Prevention - manage outbound email scanning rules and their priorities dlp.entries: description: Data Loss Prevention - list and manage detection entries dlp.limits: description: Data Loss Prevention - view account limits and resource quotas dlp.patterns: description: Data Loss Prevention - validate regular expressions used for content detection dlp.profiles: description: Data Loss Prevention - list and retrieve profiles dlp.profiles.custom: description: Data Loss Prevention - manage custom profiles dlp.profiles.predefined: description: Data Loss Prevention - manage predefined profiles dlp.sensitivity-group-templates: description: Data Loss Prevention - browse templates for creating sensitivity groups dlp.sensitivity-groups: description: Data Loss Prevention - manage sensitivity groups and their level ordering dlp.sensitivity-levels: description: Data Loss Prevention - manage sensitivity levels within sensitivity groups dlp.settings: description: Data Loss Prevention - manage account-level settings dlp.validators: description: Data Loss Prevention - list and retrieve content validators dlp.validators.proximity-words: description: Data Loss Prevention - manage proximity-word validators risk-scoring: description: User Risk Scoring - retrieve and reset user risk scores risk-scoring.behaviours: description: User Risk Scoring - manage behaviors used to calculate user risk scores risk-scoring.integrations: description: User Risk Scoring - manage integrations that provide risk score signals risk-scoring.integrations.references: description: User Risk Scoring - retrieve integrations by external reference risk-scoring.summary: description: User Risk Scoring - retrieve account risk score summaries zones: description: Zones are domains on Cloudflare — list, create, and configure domain settings groups: aegis: description: Aegis operations fonts: description: Fonts operations origin-h2-max-streams: description: Origin H2 Max Streams operations origin-max-http-version: description: Origin Max Http Version operations origin-tls-compliance-modes: description: Manage zone Origin TLS Compliance Modes setting rum: description: Rum operations speed-brain: description: Speed Brain operations