{ "opencollection": "1.0.0", "info": { "name": "Cloudflare / Accounts Zones API", "version": "4.0.0" }, "items": [ { "info": { "name": "Zones", "type": "folder" }, "items": [ { "info": { "name": "Cloudflare Get an mTLS certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single mTLS certificate." }, { "info": { "name": "Cloudflare Update an mTLS certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured mTLS certificate." }, { "info": { "name": "Cloudflare Delete an mTLS certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an mTLS certificate." }, { "info": { "name": "Cloudflare List all mTLS hostname settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates/settings", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "List all mTLS hostname settings for this zone." }, { "info": { "name": "Cloudflare Update an mTLS certificate's hostname settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates/settings", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an mTLS certificate's hostname settings." }, { "info": { "name": "Cloudflare Get the Hostname Client Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/hostnames/certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get the certificate by ID to be used for client authentication on a hostname." }, { "info": { "name": "Cloudflare Delete Hostname Client Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/hostnames/certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Hostname Client Certificate" }, { "info": { "name": "Cloudflare List Zones", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "account.id", "value": "", "type": "query" }, { "name": "account.name", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" } ] }, "docs": "Lists, searches, sorts, and filters your zones." }, { "info": { "name": "Cloudflare Create Zone", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones", "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create Zone" }, { "info": { "name": "Cloudflare List Access Applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "List all Access Applications in a zone." }, { "info": { "name": "Cloudflare Add an Access application", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new application to Access." }, { "info": { "name": "Cloudflare Get an Access application", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches information about an Access application." }, { "info": { "name": "Cloudflare Update an Access application", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an Access application." }, { "info": { "name": "Cloudflare Delete an Access application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an application from Access." }, { "info": { "name": "Cloudflare Revoke application tokens", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:app_id/revoke_tokens", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Revokes all tokens issued for an application." }, { "info": { "name": "Cloudflare Test Access policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:app_id/user_policy_checks", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Tests if a specific user has permission to access an application." }, { "info": { "name": "Cloudflare Get a short-lived certificate CA", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid/ca", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a short-lived certificate CA and its public key." }, { "info": { "name": "Cloudflare Create a short-lived certificate CA", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid/ca", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Generates a new short-lived certificate CA and public key." }, { "info": { "name": "Cloudflare Delete a short-lived certificate CA", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid/ca", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes a short-lived certificate CA." }, { "info": { "name": "Cloudflare List Access policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid/policies", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists Access policies configured for an application." }, { "info": { "name": "Cloudflare Create an Access policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid/policies", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Access policy for an application." }, { "info": { "name": "Cloudflare Get an Access policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid1/policies/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "uuid1", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single Access policy." }, { "info": { "name": "Cloudflare Update an Access policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid1/policies/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "uuid1", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a configured Access policy." }, { "info": { "name": "Cloudflare Delete an Access policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/:uuid1/policies/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "uuid1", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Delete an Access policy." }, { "info": { "name": "Cloudflare List short-lived certificate CAs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/apps/ca", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists short-lived certificate CAs and their public keys." }, { "info": { "name": "Cloudflare List mTLS certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all mTLS certificates." }, { "info": { "name": "Cloudflare Add an mTLS certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/certificates", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new mTLS root certificate to Access." }, { "info": { "name": "Cloudflare List Access groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/groups", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all Access groups." }, { "info": { "name": "Cloudflare Create an Access group", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/groups", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Access group." }, { "info": { "name": "Cloudflare Get an Access group", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/groups/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single Access group." }, { "info": { "name": "Cloudflare Update an Access group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/groups/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured Access group." }, { "info": { "name": "Cloudflare Delete an Access group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/groups/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an Access group." }, { "info": { "name": "Cloudflare List Access identity providers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/identity_providers", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all configured identity providers." }, { "info": { "name": "Cloudflare Add an Access identity provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/identity_providers", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new identity provider to Access." }, { "info": { "name": "Cloudflare Get an Access identity provider", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/identity_providers/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a configured identity provider." }, { "info": { "name": "Cloudflare Update an Access identity provider", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/identity_providers/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured identity provider." }, { "info": { "name": "Cloudflare Delete an Access identity provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/identity_providers/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes an identity provider from Access." }, { "info": { "name": "Cloudflare Get your Zero Trust organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/organizations", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Returns the configuration for your Zero Trust organization." }, { "info": { "name": "Cloudflare Create your Zero Trust organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/organizations", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets up a Zero Trust organization for your account." }, { "info": { "name": "Cloudflare Update your Zero Trust organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/organizations", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration for your Zero Trust organization." }, { "info": { "name": "Cloudflare Revoke all Access tokens for a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/organizations/revoke_user", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Revokes a user's access across all applications." }, { "info": { "name": "Cloudflare List service tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/service_tokens", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists all service tokens." }, { "info": { "name": "Cloudflare Create a service token", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/service_tokens", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token." }, { "info": { "name": "Cloudflare Update a service token", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/service_tokens/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured service token." }, { "info": { "name": "Cloudflare Delete a service token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/access/service_tokens/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Deletes a service token." }, { "info": { "name": "Cloudflare Table", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/dns_analytics/report", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "until", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters." }, { "info": { "name": "Cloudflare By Time", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/dns_analytics/report/bytime", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "until", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "time_delta", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters." }, { "info": { "name": "Cloudflare Zone Subscription Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/subscription", "params": [ { "name": "identifier", "value": "", "type": "path" } ] }, "docs": "Lists zone subscription details." }, { "info": { "name": "Cloudflare Create Zone Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/subscription", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a zone subscription, either plan or add-ons." }, { "info": { "name": "Cloudflare Update Zone Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:identifier/subscription", "params": [ { "name": "identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates zone subscriptions, either plan or add-ons." }, { "info": { "name": "Cloudflare Zone Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Zone Details" }, { "info": { "name": "Cloudflare Edit Zone", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits a zone. Only one zone property can be changed at a time." }, { "info": { "name": "Cloudflare Delete Zone", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing zone." }, { "info": { "name": "Cloudflare Total TLS Settings Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/acm/total_tls", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get Total TLS Settings for a Zone." }, { "info": { "name": "Cloudflare Enable or Disable Total TLS", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/acm/total_tls", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Total TLS Settings or disable the feature for a Zone." }, { "info": { "name": "Cloudflare Rerun the Activation Check", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/activation_check", "params": [ { "name": "zone_id", "value": "", "type": "path", "description": "Zone ID" } ] }, "docs": "Triggeres a new activation check for a PENDING Zone. This can be\ntriggered every 5 min for paygo/ent customers, every hour for FREE\nZones." }, { "info": { "name": "Cloudflare Argo Analytics for a zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/analytics/latency", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "bins", "value": "", "type": "query" } ] }, "docs": "Cloudflare Argo Analytics for a zone" }, { "info": { "name": "Cloudflare Argo Analytics for a zone at different PoPs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/analytics/latency/colos", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Argo Analytics for a zone at different PoPs" }, { "info": { "name": "Cloudflare Retrieve information about specific configuration properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/configuration", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "properties", "value": "", "type": "query" } ] }, "docs": "Cloudflare Retrieve information about specific configuration properties" }, { "info": { "name": "Cloudflare Set configuration properties", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/configuration", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Set configuration properties" }, { "info": { "name": "Cloudflare Retrieve discovered operations on a zone rendered as OpenAPI schemas", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/discovery", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the most up to date view of discovered operations, rendered as OpenAPI schemas" }, { "info": { "name": "Cloudflare Retrieve discovered operations on a zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/discovery/operations", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "Page number of paginated results." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of results per page." }, { "name": "host", "value": "", "type": "query" }, { "name": "method", "value": "", "type": "query" }, { "name": "endpoint", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "diff", "value": "", "type": "query" }, { "name": "origin", "value": "", "type": "query", "description": "Filter results to only include discovery results sourced from a particular discovery engine\n * `ML` - Discovered operations that were sourced using ML API Discovery\n * `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery\n" }, { "name": "state", "value": "", "type": "query", "description": "Filter results to only include discovery results in a particular state. States are as follows\n * `review` - Discovered operations that are not saved into API Shield Endpoint Management\n * `saved` - Discovered operations that are already saved into API Shield Endpoint Management\n * `ignored` - Discovered operations that have been marked as ignored\n" } ] }, "docs": "Retrieve the most up to date view of discovered operations" }, { "info": { "name": "Cloudflare Patch discovered operations", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/discovery/operations", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the `state` on one or more discovered operations" }, { "info": { "name": "Cloudflare Patch discovered operation", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/discovery/operations/:operation_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "operation_id", "value": "", "type": "path", "description": "Identifier for the discovered operation" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the `state` on a discovered operation" }, { "info": { "name": "Cloudflare Retrieve information about all operations on a zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "Page number of paginated results." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results to return per page" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "host", "value": "", "type": "query" }, { "name": "method", "value": "", "type": "query" }, { "name": "endpoint", "value": "", "type": "query" }, { "name": "feature", "value": "", "type": "query", "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning." } ] }, "docs": "Cloudflare Retrieve information about all operations on a zone" }, { "info": { "name": "Cloudflare Add operations to a zone", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date." }, { "info": { "name": "Cloudflare Retrieve information about an operation", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations/:operation_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "operation_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the operation" }, { "name": "feature", "value": "", "type": "query", "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning." } ] }, "docs": "Cloudflare Retrieve information about an operation" }, { "info": { "name": "Cloudflare Delete an operation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations/:operation_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "operation_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the operation" } ] }, "docs": "Cloudflare Delete an operation" }, { "info": { "name": "Cloudflare Retrieve operation-level schema validation settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations/:operation_id/schema_validation", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "operation_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the operation" } ] }, "docs": "Retrieves operation-level schema validation settings on the zone" }, { "info": { "name": "Cloudflare Update operation-level schema validation settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations/:operation_id/schema_validation", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "operation_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the operation" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates operation-level schema validation settings on the zone" }, { "info": { "name": "Cloudflare Update multiple operation-level schema validation settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/operations/schema_validation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates multiple operation-level schema validation settings on the zone" }, { "info": { "name": "Cloudflare Retrieve operations and features as OpenAPI schemas", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/schemas", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "host", "value": "", "type": "query" }, { "name": "feature", "value": "", "type": "query", "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning." } ] }, "docs": "Cloudflare Retrieve operations and features as OpenAPI schemas" }, { "info": { "name": "Cloudflare Retrieve zone level schema validation settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/settings/schema_validation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Retrieves zone level schema validation settings currently set on the zone" }, { "info": { "name": "Cloudflare Update zone level schema validation settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/settings/schema_validation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates zone level schema validation settings on the zone" }, { "info": { "name": "Cloudflare Update zone level schema validation settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/settings/schema_validation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates zone level schema validation settings on the zone" }, { "info": { "name": "Cloudflare Retrieve information about all schemas on a zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/user_schemas", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "Page number of paginated results." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of results per page." }, { "name": "omit_source", "value": "", "type": "query", "description": "Omit the source-files of schemas and only retrieve their meta-data." }, { "name": "validation_enabled", "value": "", "type": "query" } ] }, "docs": "Cloudflare Retrieve information about all schemas on a zone" }, { "info": { "name": "Cloudflare Upload a schema to a zone", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/user_schemas", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "kind", "type": "text", "value": "" }, { "name": "name", "type": "text", "value": "" }, { "name": "validation_enabled", "type": "text", "value": "" } ] } }, "docs": "Cloudflare Upload a schema to a zone" }, { "info": { "name": "Cloudflare Retrieve information about a specific schema on a zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/user_schemas/:schema_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "schema_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the schema-ID" }, { "name": "omit_source", "value": "", "type": "query", "description": "Omit the source-files of schemas and only retrieve their meta-data." } ] }, "docs": "Cloudflare Retrieve information about a specific schema on a zone" }, { "info": { "name": "Cloudflare Enable validation for a schema", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/user_schemas/:schema_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "schema_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the schema-ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Enable validation for a schema" }, { "info": { "name": "Cloudflare Delete a schema", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/user_schemas/:schema_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "schema_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the schema-ID" } ] }, "docs": "Cloudflare Delete a schema" }, { "info": { "name": "Cloudflare Retrieve all operations from a schema.", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/api_gateway/user_schemas/:schema_id/operations", "params": [ { "name": "schema_id", "value": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "type": "path", "description": "Identifier for the schema-ID" }, { "name": "zone_id", "value": "", "type": "path" }, { "name": "feature", "value": "", "type": "query", "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning." }, { "name": "host", "value": "", "type": "query" }, { "name": "method", "value": "", "type": "query" }, { "name": "endpoint", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "Page number of paginated results." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of results per page." }, { "name": "operation_status", "value": "", "type": "query", "description": "Filter results by whether operations exist in API Shield Endpoint Management or not. `new` will just return operations from the schema that do not exist in API Shield Endpoint Management. `existing` will just return operations from the schema that already exist in API Shield Endpoint Management." } ] }, "docs": "Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations." }, { "info": { "name": "Cloudflare Get Argo Smart Routing setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/argo/smart_routing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Argo Smart Routing setting" }, { "info": { "name": "Cloudflare Patch Argo Smart Routing setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/argo/smart_routing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates enablement of Argo Smart Routing." }, { "info": { "name": "Cloudflare Get Tiered Caching setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/argo/tiered_caching", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Tiered Caching setting" }, { "info": { "name": "Cloudflare Patch Tiered Caching setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/argo/tiered_caching", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates enablement of Tiered Caching" }, { "info": { "name": "Cloudflare Get Zone Bot Management Config", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/bot_management", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a zone's Bot Management Config" }, { "info": { "name": "Cloudflare Update Zone Bot Management Config", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/bot_management", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Bot Management configuration for a zone.\n\nThis API is used to update:\n- **Bot Fight Mode**\n- **Super Bot Fight Mode**\n- **Bot Management for Enterprise**\n\nSee [Bot Plans](https://developers.cloudflare.com/bots/plans/) for more information on the different plans\n" }, { "info": { "name": "Cloudflare Get Cache Reserve setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/cache_reserve", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information." }, { "info": { "name": "Cloudflare Change Cache Reserve setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/cache_reserve", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information." }, { "info": { "name": "Cloudflare Get Cache Reserve Clear", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/cache_reserve_clear", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation." }, { "info": { "name": "Cloudflare Start Cache Reserve Clear", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/cache_reserve_clear", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation." }, { "info": { "name": "Cloudflare Get Origin Post-Quantum Encryption setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/origin_post_quantum_encryption", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised" }, { "info": { "name": "Cloudflare Change Origin Post-Quantum Encryption setting", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/origin_post_quantum_encryption", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised" }, { "info": { "name": "Cloudflare Get Regional Tiered Cache setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/regional_tiered_cache", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies." }, { "info": { "name": "Cloudflare Change Regional Tiered Cache setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/regional_tiered_cache", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies." }, { "info": { "name": "Cloudflare Get Smart Tiered Cache setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/tiered_cache_smart_topology_enable", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Smart Tiered Cache setting" }, { "info": { "name": "Cloudflare Patch Smart Tiered Cache setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/tiered_cache_smart_topology_enable", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates enablement of Tiered Cache" }, { "info": { "name": "Cloudflare Delete Smart Tiered Cache setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/tiered_cache_smart_topology_enable", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remvoves enablement of Smart Tiered Cache" }, { "info": { "name": "Cloudflare Get variants setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/variants", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers." }, { "info": { "name": "Cloudflare Change variants setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/variants", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers." }, { "info": { "name": "Cloudflare Delete variants setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/cache/variants", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers." }, { "info": { "name": "Cloudflare List Hostname Associations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/certificate_authorities/hostname_associations", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "mtls_certificate_id", "value": "", "type": "query" } ] }, "docs": "List Hostname Associations" }, { "info": { "name": "Cloudflare Replace Hostname Associations", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/certificate_authorities/hostname_associations", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace Hostname Associations" }, { "info": { "name": "Cloudflare List Client Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/client_certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] }, "docs": "List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination" }, { "info": { "name": "Cloudflare Create Client Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/client_certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new API Shield mTLS Client Certificate" }, { "info": { "name": "Cloudflare Client Certificate Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/client_certificates/:client_certificate_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "client_certificate_id", "value": "", "type": "path" } ] }, "docs": "Get Details for a single mTLS API Shield Client Certificate" }, { "info": { "name": "Cloudflare Reactivate Client Certificate", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/client_certificates/:client_certificate_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "client_certificate_id", "value": "", "type": "path" } ] }, "docs": "If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint." }, { "info": { "name": "Cloudflare Revoke Client Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/client_certificates/:client_certificate_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "client_certificate_id", "value": "", "type": "path" } ] }, "docs": "Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status." }, { "info": { "name": "Cloudflare List SSL Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates." }, { "info": { "name": "Cloudflare Create SSL Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a new SSL certificate for a zone." }, { "info": { "name": "Cloudflare SSL Configuration Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_certificates/:custom_certificate_id", "params": [ { "name": "custom_certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare SSL Configuration Details" }, { "info": { "name": "Cloudflare Edit SSL Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_certificates/:custom_certificate_id", "params": [ { "name": "custom_certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted." }, { "info": { "name": "Cloudflare Delete SSL Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_certificates/:custom_certificate_id", "params": [ { "name": "custom_certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a SSL certificate from a zone." }, { "info": { "name": "Cloudflare Re-prioritize SSL Certificates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_certificates/prioritize", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates." }, { "info": { "name": "Cloudflare List Custom Hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "hostname", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "ssl", "value": "", "type": "query" } ] }, "docs": "List, search, sort, and filter all of your custom hostnames." }, { "info": { "name": "Cloudflare Create Custom Hostname", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 co" }, { "info": { "name": "Cloudflare Custom Hostname Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames/:custom_hostname_id", "params": [ { "name": "custom_hostname_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Custom Hostname Details" }, { "info": { "name": "Cloudflare Edit Custom Hostname", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames/:custom_hostname_id", "params": [ { "name": "custom_hostname_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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'." }, { "info": { "name": "Cloudflare Delete Custom Hostname (and any issued SSL certificates)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames/:custom_hostname_id", "params": [ { "name": "custom_hostname_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Custom Hostname (and any issued SSL certificates)" }, { "info": { "name": "Cloudflare Get Fallback Origin for Custom Hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames/fallback_origin", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Fallback Origin for Custom Hostnames" }, { "info": { "name": "Cloudflare Update Fallback Origin for Custom Hostnames", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames/fallback_origin", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Update Fallback Origin for Custom Hostnames" }, { "info": { "name": "Cloudflare Delete Fallback Origin for Custom Hostnames", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_hostnames/fallback_origin", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Fallback Origin for Custom Hostnames" }, { "info": { "name": "Cloudflare Get Account Custom Nameserver Related Zone Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_ns", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get metadata for account-level custom nameservers on a zone.\n" }, { "info": { "name": "Cloudflare Set Account Custom Nameserver Related Zone Metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/custom_ns", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set metadata for account-level custom nameservers on a zone.\n\nIf you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.\n" }, { "info": { "name": "Cloudflare Retrieve the DCV Delegation unique identifier.", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dcv_delegation/uuid", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation." }, { "info": { "name": "Cloudflare List DNS Records", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "content", "value": "", "type": "query" }, { "name": "proxied", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "comment", "value": "", "type": "query" }, { "name": "comment.present", "value": "", "type": "query" }, { "name": "comment.absent", "value": "", "type": "query" }, { "name": "comment.exact", "value": "", "type": "query" }, { "name": "comment.contains", "value": "", "type": "query" }, { "name": "comment.startswith", "value": "", "type": "query" }, { "name": "comment.endswith", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag.present", "value": "", "type": "query" }, { "name": "tag.absent", "value": "", "type": "query" }, { "name": "tag.exact", "value": "", "type": "query" }, { "name": "tag.contains", "value": "", "type": "query" }, { "name": "tag.startswith", "value": "", "type": "query" }, { "name": "tag.endswith", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" }, { "name": "tag_match", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "List, search, sort, and filter a zones' DNS records." }, { "info": { "name": "Cloudflare Create DNS Record", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new DNS record for a zone.\n\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n characters were used when creating the record.\n" }, { "info": { "name": "Cloudflare DNS Record Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/:dns_record_id", "params": [ { "name": "dns_record_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare DNS Record Details" }, { "info": { "name": "Cloudflare Overwrite DNS Record", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/:dns_record_id", "params": [ { "name": "dns_record_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overwrite an existing DNS record.\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n characters were used when creating the record.\n" }, { "info": { "name": "Cloudflare Update DNS Record", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/:dns_record_id", "params": [ { "name": "dns_record_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing DNS record.\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n characters were used when creating the record.\n" }, { "info": { "name": "Cloudflare Delete DNS Record", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/:dns_record_id", "params": [ { "name": "dns_record_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete DNS Record" }, { "info": { "name": "Cloudflare Export DNS Records", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/export", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information." }, { "info": { "name": "Cloudflare Import DNS Records", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/import", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "proxied", "type": "text", "value": "" } ] } }, "docs": "You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information." }, { "info": { "name": "Cloudflare Scan DNS Records", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dns_records/scan", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet." }, { "info": { "name": "Cloudflare DNSSEC Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dnssec", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Details about DNSSEC status and configuration." }, { "info": { "name": "Cloudflare Edit DNSSEC Status", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dnssec", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable DNSSEC." }, { "info": { "name": "Cloudflare Delete DNSSEC records", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/dnssec", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete DNSSEC." }, { "info": { "name": "Cloudflare List IP Access rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/access_rules/rules", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "filters", "value": "", "type": "query" }, { "name": "egs-pagination.json", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "Fetches IP Access rules of a zone. You can filter the results using several optional parameters." }, { "info": { "name": "Cloudflare Create an IP Access rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/access_rules/rules", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new IP Access rule for a zone.\n\nNote: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate." }, { "info": { "name": "Cloudflare Update an IP Access rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes." }, { "info": { "name": "Cloudflare Delete an IP Access rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/access_rules/rules/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an IP Access rule defined at the zone level.\n\nOptionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner." }, { "info": { "name": "Cloudflare List WAF rule groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/waf/packages/:package_id/groups", "params": [ { "name": "package_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" }, { "name": "mode", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "rules_count", "value": "", "type": "query" } ] }, "docs": "Fetches the WAF rule groups in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Get a WAF rule group", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/waf/packages/:package_id/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" }, { "name": "package_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a WAF rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Update a WAF rule group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/waf/packages/:package_id/groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path" }, { "name": "package_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare List WAF rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/waf/packages/:package_id/rules", "params": [ { "name": "package_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" }, { "name": "mode", "value": "", "type": "query" }, { "name": "group_id", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "priority", "value": "", "type": "query" } ] }, "docs": "Fetches WAF rules in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Get a WAF rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/waf/packages/:package_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "package_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a WAF rule in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Update a WAF rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/firewall/waf/packages/:package_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "package_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a WAF rule. You can only update the mode/action of the rule.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Get Zone Hold", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/hold", "params": [ { "name": "zone_id", "value": "", "type": "path", "description": "Zone ID" } ] }, "docs": "Retrieve whether the zone is subject to a zone hold, and metadata about the hold." }, { "info": { "name": "Cloudflare Create Zone Hold", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/hold", "params": [ { "name": "zone_id", "value": "", "type": "path", "description": "Zone ID" }, { "name": "include_subdomains", "value": "true", "type": "query", "description": "If provided, the zone hold will extend to block any subdomain of the given zone, as well\nas SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname\n'example.com' and include_subdomains=true will block 'example.com',\n'staging.example.com', 'api.staging.example.com', etc." } ] }, "docs": "Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname." }, { "info": { "name": "Cloudflare Remove Zone Hold", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/hold", "params": [ { "name": "zone_id", "value": "", "type": "path", "description": "Zone ID" }, { "name": "hold_after", "value": "2023-01-31T15:56:36+00:00", "type": "query", "description": "If `hold_after` is provided, the hold will be temporarily disabled,\nthen automatically re-enabled by the system at the time specified\nin this RFC3339-formatted timestamp. Otherwise, the hold will be\ndisabled indefinitely." } ] }, "docs": "Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the\ncreation and activation of zones with this zone's hostname." }, { "info": { "name": "Cloudflare List TLS setting for hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/hostnames/settings/:setting_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "setting_id", "value": "", "type": "path" } ] }, "docs": "List the requested TLS setting for the hostnames under this zone." }, { "info": { "name": "Cloudflare Edit TLS setting for hostname", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/hostnames/settings/:setting_id/:hostname", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "setting_id", "value": "", "type": "path" }, { "name": "hostname", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the tls setting value for the hostname." }, { "info": { "name": "Cloudflare Delete TLS setting for hostname", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/hostnames/settings/:setting_id/:hostname", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "setting_id", "value": "", "type": "path" }, { "name": "hostname", "value": "", "type": "path" } ] }, "docs": "Delete the tls setting value for the hostname." }, { "info": { "name": "Cloudflare List Keyless SSL Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/keyless_certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "List all Keyless SSL configurations for a given zone." }, { "info": { "name": "Cloudflare Create Keyless SSL Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/keyless_certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create Keyless SSL Configuration" }, { "info": { "name": "Cloudflare Get Keyless SSL Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/keyless_certificates/:keyless_certificate_id", "params": [ { "name": "keyless_certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get details for one Keyless SSL configuration." }, { "info": { "name": "Cloudflare Edit Keyless SSL Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/keyless_certificates/:keyless_certificate_id", "params": [ { "name": "keyless_certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port." }, { "info": { "name": "Cloudflare Delete Keyless SSL Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/keyless_certificates/:keyless_certificate_id", "params": [ { "name": "keyless_certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Keyless SSL Configuration" }, { "info": { "name": "Cloudflare List Load Balancers", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/load_balancers", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "List configured load balancers." }, { "info": { "name": "Cloudflare Create Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/load_balancers", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new load balancer." }, { "info": { "name": "Cloudflare Load Balancer Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/load_balancers/:load_balancer_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "load_balancer_id", "value": "", "type": "path" } ] }, "docs": "Fetch a single configured load balancer." }, { "info": { "name": "Cloudflare Update Load Balancer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/load_balancers/:load_balancer_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "load_balancer_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a configured load balancer." }, { "info": { "name": "Cloudflare Patch Load Balancer", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/load_balancers/:load_balancer_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "load_balancer_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply changes to an existing load balancer, overwriting the supplied properties." }, { "info": { "name": "Cloudflare Delete Load Balancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/load_balancers/:load_balancer_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "load_balancer_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a configured load balancer." }, { "info": { "name": "Cloudflare List fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/datasets/:dataset_id/fields", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions." }, { "info": { "name": "Cloudflare List Logpush jobs for a dataset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/datasets/:dataset_id/jobs", "params": [ { "name": "dataset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Lists Logpush jobs for a zone for a dataset." }, { "info": { "name": "Cloudflare List Instant Logs jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/edge", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Lists Instant Logs jobs for a zone." }, { "info": { "name": "Cloudflare Create Instant Logs job", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/edge", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Instant Logs job for a zone." }, { "info": { "name": "Cloudflare List Logpush jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/jobs", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Lists Logpush jobs for a zone." }, { "info": { "name": "Cloudflare Create Logpush job", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/jobs", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Logpush job for a zone." }, { "info": { "name": "Cloudflare Get Logpush job details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets the details of a Logpush job." }, { "info": { "name": "Cloudflare Update Logpush job", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Logpush job." }, { "info": { "name": "Cloudflare Delete Logpush job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a Logpush job." }, { "info": { "name": "Cloudflare Get ownership challenge", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/ownership", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets a new ownership challenge sent to your destination." }, { "info": { "name": "Cloudflare Validate ownership challenge", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/ownership/validate", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates ownership challenge of the destination." }, { "info": { "name": "Cloudflare Check destination exists", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/validate/destination/exists", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Checks if there is an existing job with a destination." }, { "info": { "name": "Cloudflare Validate origin", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/logpush/validate/origin", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates logpull origin with logpull_options." }, { "info": { "name": "Cloudflare List Managed Transforms", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/managed_headers", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches a list of all Managed Transforms." }, { "info": { "name": "Cloudflare Update status of Managed Transforms", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/managed_headers", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of one or more Managed Transforms." }, { "info": { "name": "Cloudflare List Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare List Certificates" }, { "info": { "name": "Cloudflare Upload Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use." }, { "info": { "name": "Cloudflare Get Certificate Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get Certificate Details" }, { "info": { "name": "Cloudflare Delete Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Certificate" }, { "info": { "name": "Cloudflare Enable or Disable a Hostname for Client Authentication", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/hostnames", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association." }, { "info": { "name": "Cloudflare Get the Hostname Status for Client Authentication", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/hostnames/:hostname", "params": [ { "name": "hostname", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get the Hostname Status for Client Authentication" }, { "info": { "name": "Cloudflare List Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/hostnames/certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare List Certificates" }, { "info": { "name": "Cloudflare Upload a Hostname Client Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/hostnames/certificates", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed." }, { "info": { "name": "Cloudflare Get Enablement Setting for Zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get whether zone-level authenticated origin pulls is enabled or not. It is false by default." }, { "info": { "name": "Cloudflare Set Enablement for Zone", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/origin_tls_client_auth/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use." }, { "info": { "name": "Cloudflare Get Page Shield settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the Page Shield settings." }, { "info": { "name": "Cloudflare Update Page Shield settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Page Shield settings." }, { "info": { "name": "Cloudflare List Page Shield connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/connections", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "exclude_urls", "value": "", "type": "query" }, { "name": "urls", "value": "", "type": "query" }, { "name": "hosts", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "prioritize_malicious", "value": "", "type": "query" }, { "name": "exclude_cdn_cgi", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "page_url", "value": "", "type": "query" }, { "name": "export", "value": "", "type": "query" } ] }, "docs": "Lists all connections detected by Page Shield." }, { "info": { "name": "Cloudflare Get a Page Shield connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/connections/:connection_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "connection_id", "value": "", "type": "path" } ] }, "docs": "Fetches a connection detected by Page Shield by connection ID." }, { "info": { "name": "Cloudflare List Page Shield policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/policies", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Lists all Page Shield policies." }, { "info": { "name": "Cloudflare Create a Page Shield policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/policies", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Page Shield policy." }, { "info": { "name": "Cloudflare Get a Page Shield policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/policies/:policy_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "policy_id", "value": "", "type": "path" } ] }, "docs": "Fetches a Page Shield policy by ID." }, { "info": { "name": "Cloudflare Update a Page Shield policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/policies/:policy_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "policy_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Page Shield policy by ID." }, { "info": { "name": "Cloudflare Delete a Page Shield policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/policies/:policy_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "policy_id", "value": "", "type": "path" } ] }, "docs": "Delete a Page Shield policy by ID." }, { "info": { "name": "Cloudflare List Page Shield scripts", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/scripts", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "exclude_urls", "value": "", "type": "query" }, { "name": "urls", "value": "", "type": "query" }, { "name": "hosts", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order_by", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "prioritize_malicious", "value": "", "type": "query" }, { "name": "exclude_cdn_cgi", "value": "", "type": "query" }, { "name": "exclude_duplicates", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "page_url", "value": "", "type": "query" }, { "name": "export", "value": "", "type": "query" } ] }, "docs": "Lists all scripts detected by Page Shield." }, { "info": { "name": "Cloudflare Get a Page Shield script", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/page_shield/scripts/:script_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "script_id", "value": "", "type": "path" } ] }, "docs": "Fetches a script detected by Page Shield by script ID." }, { "info": { "name": "Cloudflare List Page Rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "Fetches Page Rules in a zone." }, { "info": { "name": "Cloudflare Create a Page Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Page Rule." }, { "info": { "name": "Cloudflare Get a Page Rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules/:pagerule_id", "params": [ { "name": "pagerule_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a Page Rule." }, { "info": { "name": "Cloudflare Update a Page Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules/:pagerule_id", "params": [ { "name": "pagerule_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request." }, { "info": { "name": "Cloudflare Edit a Page Rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules/:pagerule_id", "params": [ { "name": "pagerule_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more fields of an existing Page Rule." }, { "info": { "name": "Cloudflare Delete a Page Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules/:pagerule_id", "params": [ { "name": "pagerule_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing Page Rule." }, { "info": { "name": "Cloudflare List available Page Rules settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/pagerules/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Returns a list of settings (and their details) that Page Rules can apply to matching requests." }, { "info": { "name": "Cloudflare Purge Cached Content", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/purge_cache", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "### Purge All Cached Content\nRemoves ALL files from Cloudflare's cache. All tiers can purge everything.\n\n### Purge Cached Content by URL\nGranularly removes one or more files from Cloudflare's cache by specifying URLs. All tiers can purge by URL.\n\nTo purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers. If you have lang in your" }, { "info": { "name": "Cloudflare List zone rulesets", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches all rulesets at the zone level." }, { "info": { "name": "Cloudflare Create a zone ruleset", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a ruleset at the zone level." }, { "info": { "name": "Cloudflare Get a zone ruleset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the latest version of a zone ruleset." }, { "info": { "name": "Cloudflare Update a zone ruleset", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a zone ruleset, creating a new version." }, { "info": { "name": "Cloudflare Delete a zone ruleset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Deletes all versions of an existing zone ruleset." }, { "info": { "name": "Cloudflare Create a zone ruleset rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id/rules", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default." }, { "info": { "name": "Cloudflare Update a zone ruleset rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing rule in a zone ruleset." }, { "info": { "name": "Cloudflare Delete a zone ruleset rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing rule from a zone ruleset." }, { "info": { "name": "Cloudflare List a zone ruleset's versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id/versions", "params": [ { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the versions of a zone ruleset." }, { "info": { "name": "Cloudflare Get a zone ruleset version", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id/versions/:ruleset_version", "params": [ { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches a specific version of a zone ruleset." }, { "info": { "name": "Cloudflare Delete a zone ruleset version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/:ruleset_id/versions/:ruleset_version", "params": [ { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Deletes an existing version of a zone ruleset." }, { "info": { "name": "Cloudflare Get a zone entry point ruleset", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint", "params": [ { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the latest version of the zone entry point ruleset for a given phase." }, { "info": { "name": "Cloudflare Update a zone entry point ruleset", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint", "params": [ { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a zone entry point ruleset, creating a new version." }, { "info": { "name": "Cloudflare List a zone entry point ruleset's versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint/versions", "params": [ { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the versions of a zone entry point ruleset." }, { "info": { "name": "Cloudflare Get a zone entry point ruleset version", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/rulesets/phases/:ruleset_phase/entrypoint/versions/:ruleset_version", "params": [ { "name": "ruleset_version", "value": "", "type": "path" }, { "name": "ruleset_phase", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches a specific version of a zone entry point ruleset." }, { "info": { "name": "Cloudflare Force AXFR", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/force_axfr", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends AXFR zone transfer request to primary nameserver(s)." }, { "info": { "name": "Cloudflare Secondary Zone Configuration Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/incoming", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get secondary zone configuration for incoming zone transfers." }, { "info": { "name": "Cloudflare Create Secondary Zone Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/incoming", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create secondary zone configuration for incoming zone transfers." }, { "info": { "name": "Cloudflare Update Secondary Zone Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/incoming", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update secondary zone configuration for incoming zone transfers." }, { "info": { "name": "Cloudflare Delete Secondary Zone Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/incoming", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete secondary zone configuration for incoming zone transfers." }, { "info": { "name": "Cloudflare Primary Zone Configuration Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get primary zone configuration for outgoing zone transfers." }, { "info": { "name": "Cloudflare Create Primary Zone Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create primary zone configuration for outgoing zone transfers." }, { "info": { "name": "Cloudflare Update Primary Zone Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update primary zone configuration for outgoing zone transfers." }, { "info": { "name": "Cloudflare Delete Primary Zone Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete primary zone configuration for outgoing zone transfers." }, { "info": { "name": "Cloudflare Disable Outgoing Zone Transfers", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing/disable", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone." }, { "info": { "name": "Cloudflare Enable Outgoing Zone Transfers", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing/enable", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable outgoing zone transfers for primary zone." }, { "info": { "name": "Cloudflare Force DNS NOTIFY", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing/force_notify", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone." }, { "info": { "name": "Cloudflare Get Outgoing Zone Transfer Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/secondary_dns/outgoing/status", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get primary zone transfer status." }, { "info": { "name": "Cloudflare Get all Zone settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Available settings for your user in relation to a zone." }, { "info": { "name": "Cloudflare Edit zone settings info", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit settings for a zone." }, { "info": { "name": "Cloudflare Get 0-RTT session resumption setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/0rtt", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets 0-RTT session resumption setting." }, { "info": { "name": "Cloudflare Change 0-RTT session resumption setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/0rtt", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the 0-RTT session resumption setting." }, { "info": { "name": "Cloudflare Get Advanced DDOS setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/advanced_ddos", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones." }, { "info": { "name": "Cloudflare Get Always Online setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/always_online", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information." }, { "info": { "name": "Cloudflare Change Always Online setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/always_online", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information." }, { "info": { "name": "Cloudflare Get Always Use HTTPS setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/always_use_https", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule." }, { "info": { "name": "Cloudflare Change Always Use HTTPS setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/always_use_https", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule." }, { "info": { "name": "Cloudflare Get Automatic HTTPS Rewrites setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/automatic_https_rewrites", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enable the Automatic HTTPS Rewrites feature for this zone." }, { "info": { "name": "Cloudflare Change Automatic HTTPS Rewrites setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/automatic_https_rewrites", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable the Automatic HTTPS Rewrites feature for this zone." }, { "info": { "name": "Cloudflare Get Automatic Platform Optimization for WordPress setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/automatic_platform_optimization", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)\nserves your WordPress site from Cloudflare's edge network and caches\nthird-party fonts.\n" }, { "info": { "name": "Cloudflare Change Automatic Platform Optimization for WordPress setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/automatic_platform_optimization", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)\nserves your WordPress site from Cloudflare's edge network and caches\nthird-party fonts.\n" }, { "info": { "name": "Cloudflare Get Brotli setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/brotli", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset." }, { "info": { "name": "Cloudflare Change Brotli setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/brotli", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset." }, { "info": { "name": "Cloudflare Get Browser Cache TTL setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/browser_cache_ttl", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276)." }, { "info": { "name": "Cloudflare Change Browser Cache TTL setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/browser_cache_ttl", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276)." }, { "info": { "name": "Cloudflare Get Browser Check setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/browser_check", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086)." }, { "info": { "name": "Cloudflare Change Browser Check setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/browser_check", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086)." }, { "info": { "name": "Cloudflare Get Cache Level setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/cache_level", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256)." }, { "info": { "name": "Cloudflare Change Cache Level setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/cache_level", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256)." }, { "info": { "name": "Cloudflare Get Challenge TTL setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/challenge_ttl", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136)." }, { "info": { "name": "Cloudflare Change Challenge TTL setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/challenge_ttl", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136)." }, { "info": { "name": "Cloudflare Get ciphers setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ciphers", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets ciphers setting." }, { "info": { "name": "Cloudflare Change ciphers setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ciphers", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes ciphers setting." }, { "info": { "name": "Cloudflare Get Development Mode setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/development_mode", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off." }, { "info": { "name": "Cloudflare Change Development Mode setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/development_mode", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off." }, { "info": { "name": "Cloudflare Get Early Hints setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/early_hints", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information." }, { "info": { "name": "Cloudflare Change Early Hints setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/early_hints", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information." }, { "info": { "name": "Cloudflare Get Email Obfuscation setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/email_obfuscation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016)." }, { "info": { "name": "Cloudflare Change Email Obfuscation setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/email_obfuscation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016)." }, { "info": { "name": "Get Cloudflare Fonts setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/fonts", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,\nboost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.\n" }, { "info": { "name": "Change Cloudflare Fonts setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/fonts", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,\nboost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.\n" }, { "info": { "name": "Cloudflare Get HTTP/2 Edge Prioritization setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/h2_prioritization", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets HTTP/2 Edge Prioritization setting.\n" }, { "info": { "name": "Cloudflare Change HTTP/2 Edge Prioritization setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/h2_prioritization", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets HTTP/2 Edge Prioritization setting.\n" }, { "info": { "name": "Cloudflare Get Hotlink Protection setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/hotlink_protection", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026)." }, { "info": { "name": "Cloudflare Change Hotlink Protection setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/hotlink_protection", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026)." }, { "info": { "name": "Cloudflare Get HTTP2 setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/http2", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Value of the HTTP2 setting." }, { "info": { "name": "Cloudflare Change HTTP2 setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/http2", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Value of the HTTP2 setting." }, { "info": { "name": "Cloudflare Get HTTP3 setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/http3", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Value of the HTTP3 setting." }, { "info": { "name": "Cloudflare Change HTTP3 setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/http3", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Value of the HTTP3 setting." }, { "info": { "name": "Cloudflare Get Image Resizing setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/image_resizing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Image Resizing provides on-demand resizing, conversion and optimisation\nfor images served through Cloudflare's network. Refer to the\n[Image Resizing documentation](https://developers.cloudflare.com/images/)\nfor more information.\n" }, { "info": { "name": "Cloudflare Change Image Resizing setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/image_resizing", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Image Resizing provides on-demand resizing, conversion and optimisation\nfor images served through Cloudflare's network. Refer to the\n[Image Resizing documentation](https://developers.cloudflare.com/images/)\nfor more information.\n" }, { "info": { "name": "Cloudflare Get IP Geolocation setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ip_geolocation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236)." }, { "info": { "name": "Cloudflare Change IP Geolocation setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ip_geolocation", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236)." }, { "info": { "name": "Cloudflare Get IPv6 setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ipv6", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586)." }, { "info": { "name": "Cloudflare Change IPv6 setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ipv6", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586)." }, { "info": { "name": "Cloudflare Get Minimum TLS Version setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/min_tls_version", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets Minimum TLS Version setting." }, { "info": { "name": "Cloudflare Change Minimum TLS Version setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/min_tls_version", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes Minimum TLS Version setting." }, { "info": { "name": "Cloudflare Get Minify setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/minify", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information." }, { "info": { "name": "Cloudflare Change Minify setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/minify", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information." }, { "info": { "name": "Cloudflare Get Mirage setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/mirage", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Automatically optimize image loading for website visitors on mobile\ndevices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)\nfor more information.\n" }, { "info": { "name": "Cloudflare Change Mirage setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/mirage", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information." }, { "info": { "name": "Cloudflare Get Mobile Redirect setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/mobile_redirect", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information." }, { "info": { "name": "Cloudflare Change Mobile Redirect setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/mobile_redirect", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information." }, { "info": { "name": "Cloudflare Get Network Error Logging setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/nel", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enable Network Error Logging reporting on your zone. (Beta)\n" }, { "info": { "name": "Cloudflare Change Network Error Logging setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/nel", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/nel-solving-mobile-speed) for more information." }, { "info": { "name": "Cloudflare Get Opportunistic Encryption setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/opportunistic_encryption", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets Opportunistic Encryption setting." }, { "info": { "name": "Cloudflare Change Opportunistic Encryption setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/opportunistic_encryption", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes Opportunistic Encryption setting." }, { "info": { "name": "Cloudflare Get Opportunistic Onion setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/opportunistic_onion", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes." }, { "info": { "name": "Cloudflare Change Opportunistic Onion setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/opportunistic_onion", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes." }, { "info": { "name": "Cloudflare Get Orange to Orange (O2O) setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/orange_to_orange", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other\nzones also on Cloudflare.\n" }, { "info": { "name": "Cloudflare Change Orange to Orange (O2O) setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/orange_to_orange", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other\nzones also on Cloudflare.\n" }, { "info": { "name": "Cloudflare Get Enable Error Pages On setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/origin_error_page_pass_thru", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Change Enable Error Pages On setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/origin_error_page_pass_thru", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Get Origin Max HTTP Version Setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/origin_max_http_version", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is \"2\" for all plan types except ENT where it is \"1\"" }, { "info": { "name": "Cloudflare Change Origin Max HTTP Version Setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/origin_max_http_version", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is \"2\" for all plan types except ENT where it is \"1\"" }, { "info": { "name": "Cloudflare Get Polish setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/polish", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Automatically optimize image loading for website visitors on mobile\ndevices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed)\nfor more information.\n" }, { "info": { "name": "Cloudflare Change Polish setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/polish", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed) for more information." }, { "info": { "name": "Cloudflare Get prefetch preload setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/prefetch_preload", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Change prefetch preload setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/prefetch_preload", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Get Proxy Read Timeout setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/proxy_read_timeout", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Maximum time between two read operations from origin.\n" }, { "info": { "name": "Cloudflare Change Proxy Read Timeout setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/proxy_read_timeout", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Maximum time between two read operations from origin.\n" }, { "info": { "name": "Cloudflare Get Pseudo IPv4 setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/pseudo_ipv4", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Value of the Pseudo IPv4 setting." }, { "info": { "name": "Cloudflare Change Pseudo IPv4 setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/pseudo_ipv4", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Value of the Pseudo IPv4 setting." }, { "info": { "name": "Cloudflare Get Response Buffering setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/response_buffering", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Change Response Buffering setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/response_buffering", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Get Rocket Loader setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/rocket_loader", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Rocket Loader is a general-purpose asynchronous JavaScript optimisation\nthat prioritises rendering your content while loading your site's\nJavascript asynchronously. Turning on Rocket Loader will immediately\nimprove a web page's rendering time sometimes measured as Time to First\nPaint (TTFP), and also the `window.onload` time (assuming there is\nJavaScript on the page). This can have a positive impact on your Google\nsearch ranking. When turned on, Rocket Loader will automatically defer\nthe loading" }, { "info": { "name": "Cloudflare Change Rocket Loader setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/rocket_loader", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rocket Loader is a general-purpose asynchronous JavaScript optimisation\nthat prioritises rendering your content while loading your site's\nJavascript asynchronously. Turning on Rocket Loader will immediately\nimprove a web page's rendering time sometimes measured as Time to First\nPaint (TTFP), and also the `window.onload` time (assuming there is\nJavaScript on the page). This can have a positive impact on your Google\nsearch ranking. When turned on, Rocket Loader will automatically defer\nthe loading" }, { "info": { "name": "Cloudflare Get Security Header (HSTS) setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/security_header", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare security header for a zone." }, { "info": { "name": "Cloudflare Change Security Header (HSTS) setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/security_header", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare security header for a zone." }, { "info": { "name": "Cloudflare Get Security Level setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/security_level", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056)." }, { "info": { "name": "Cloudflare Change Security Level setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/security_level", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056)." }, { "info": { "name": "Cloudflare Get Server Side Exclude setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/server_side_exclude", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't " }, { "info": { "name": "Cloudflare Change Server Side Exclude setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/server_side_exclude", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: . For example: Bad visitors won't see my phone number, 555-555-5555 . Note: SSE only will work with HTML. If you have HTML minification enabled, you won't " }, { "info": { "name": "Cloudflare Get Enable Query String Sort setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/sort_query_string_for_cache", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Change Enable Query String Sort setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/sort_query_string_for_cache", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Get SSL setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ssl", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't n" }, { "info": { "name": "Cloudflare Change SSL setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ssl", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't n" }, { "info": { "name": "Cloudflare Get SSL/TLS Recommender enrollment setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ssl_recommender", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Enrollment in the SSL/TLS Recommender service which tries to detect and\nrecommend (by sending periodic emails) the most secure SSL/TLS setting\nyour origin servers support.\n" }, { "info": { "name": "Cloudflare Change SSL/TLS Recommender enrollment setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/ssl_recommender", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enrollment in the SSL/TLS Recommender service which tries to detect and\nrecommend (by sending periodic emails) the most secure SSL/TLS setting\nyour origin servers support.\n" }, { "info": { "name": "Cloudflare Get TLS 1.3 setting enabled for a zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/tls_1_3", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets TLS 1.3 setting enabled for a zone." }, { "info": { "name": "Cloudflare Change TLS 1.3 setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/tls_1_3", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes TLS 1.3 setting." }, { "info": { "name": "Cloudflare Get TLS Client Auth setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/tls_client_auth", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only)." }, { "info": { "name": "Cloudflare Change TLS Client Auth setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/tls_client_auth", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only)." }, { "info": { "name": "Cloudflare Get True Client IP setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/true_client_ip_header", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Change True Client IP setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/true_client_ip_header", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones." }, { "info": { "name": "Cloudflare Get Web Application Firewall (WAF) setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/waf", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the ac" }, { "info": { "name": "Cloudflare Change Web Application Firewall (WAF) setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/waf", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the ac" }, { "info": { "name": "Cloudflare Get WebP setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/webp", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image." }, { "info": { "name": "Cloudflare Change WebP setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/webp", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image." }, { "info": { "name": "Cloudflare Get WebSockets setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/websockets", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets)." }, { "info": { "name": "Cloudflare Change WebSockets setting", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/websockets", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets)." }, { "info": { "name": "Cloudflare Get Zaraz configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/config", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included." }, { "info": { "name": "Cloudflare Update Zaraz configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/config", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Zaraz configuration for a zone." }, { "info": { "name": "Cloudflare Get default Zaraz configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/default", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets default Zaraz configuration for a zone." }, { "info": { "name": "Cloudflare Export Zaraz configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/export", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Exports full current published Zaraz configuration for a zone, secret variables included." }, { "info": { "name": "Cloudflare List Zaraz historical configuration records", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/history", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "offset", "value": "0", "type": "query", "description": "Ordinal number to start listing the results with. Default value is 0." }, { "name": "limit", "value": "10", "type": "query", "description": "Maximum amount of results to list. Default value is 10." }, { "name": "sortField", "value": "updated_at", "type": "query", "description": "The field to sort by. Default is updated_at." }, { "name": "sortOrder", "value": "DESC", "type": "query", "description": "Sorting order. Default is DESC." } ] }, "docs": "Lists a history of published Zaraz configuration records for a zone." }, { "info": { "name": "Cloudflare Restore Zaraz historical configuration by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/history", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a historical published Zaraz configuration by ID for a zone." }, { "info": { "name": "Cloudflare Get Zaraz historical configurations by ID(s)", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/history/configs", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "ids", "value": "12345,23456", "type": "query", "description": "Comma separated list of Zaraz configuration IDs" } ] }, "docs": "Gets a history of published Zaraz configurations by ID(s) for a zone." }, { "info": { "name": "Cloudflare Publish Zaraz preview configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/publish", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publish current Zaraz preview configuration for a zone." }, { "info": { "name": "Cloudflare Get Zaraz workflow", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/workflow", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Gets Zaraz workflow for a zone." }, { "info": { "name": "Cloudflare Update Zaraz workflow", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/settings/zaraz/workflow", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Zaraz workflow for a zone." }, { "info": { "name": "Cloudflare Get quota and availability", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/availabilities", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Retrieves quota for all plans, as well as the current zone quota." }, { "info": { "name": "Cloudflare List tested webpages", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/pages", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Lists all webpages which have been tested." }, { "info": { "name": "Cloudflare List page test history", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/pages/:url/tests", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "region", "value": "", "type": "query" } ] }, "docs": "Test history (list of tests) for a specific webpage." }, { "info": { "name": "Cloudflare Start page test", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/pages/:url/tests", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Starts a test for a specific webpage, in a specific region." }, { "info": { "name": "Cloudflare Delete all page tests", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/pages/:url/tests", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "query" } ] }, "docs": "Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota." }, { "info": { "name": "Cloudflare Get a page test result", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/pages/:url/tests/:test_id", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "test_id", "value": "", "type": "path" } ] }, "docs": "Retrieves the result of a specific test." }, { "info": { "name": "Cloudflare List core web vital metrics trend", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/pages/:url/trend", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "query" }, { "name": "deviceType", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "tz", "value": "America/Chicago", "type": "query", "description": "The timezone of the start and end timestamps." }, { "name": "metrics", "value": "", "type": "query", "description": "A comma-separated list of metrics to include in the results." } ] }, "docs": "Lists the core web vital metrics trend over time for a specific page." }, { "info": { "name": "Cloudflare Get a page test schedule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/schedule/:url", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "query" } ] }, "docs": "Retrieves the test schedule for a page in a specific region." }, { "info": { "name": "Cloudflare Create scheduled page test", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/schedule/:url", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "query" } ] }, "docs": "Creates a scheduled test for a page." }, { "info": { "name": "Cloudflare Delete scheduled page test", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/speed_api/schedule/:url", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "query" } ] }, "docs": "Deletes a scheduled test for a page." }, { "info": { "name": "Cloudflare Analyze Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/analyze", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate." }, { "info": { "name": "Cloudflare List Certificate Packs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/certificate_packs", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "For a given zone, list all active certificate packs." }, { "info": { "name": "Cloudflare Get Certificate Pack", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/certificate_packs/:certificate_pack_id", "params": [ { "name": "certificate_pack_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "For a given zone, get a certificate pack." }, { "info": { "name": "Cloudflare Restart Validation for Advanced Certificate Manager Certificate Pack", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/certificate_packs/:certificate_pack_id", "params": [ { "name": "certificate_pack_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status." }, { "info": { "name": "Cloudflare Delete Advanced Certificate Manager Certificate Pack", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/certificate_packs/:certificate_pack_id", "params": [ { "name": "certificate_pack_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "For a given zone, delete an advanced certificate pack." }, { "info": { "name": "Cloudflare Order Advanced Certificate Manager Certificate Pack", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/certificate_packs/order", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "For a given zone, order an advanced certificate pack." }, { "info": { "name": "Cloudflare Get Certificate Pack Quotas", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/certificate_packs/quota", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "For a given zone, list certificate pack quotas." }, { "info": { "name": "Cloudflare Universal SSL Settings Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/universal/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Get Universal SSL Settings for a Zone." }, { "info": { "name": "Cloudflare Edit Universal SSL Settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/universal/settings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch Universal SSL Settings for a Zone." }, { "info": { "name": "Cloudflare SSL Verification Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/verification", "params": [ { "name": "zone_id", "value": "", "type": "path" }, { "name": "retry", "value": "", "type": "query" } ] }, "docs": "Get SSL Verification Info for a Zone." }, { "info": { "name": "Cloudflare Edit SSL Certificate Pack Validation Method", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/ssl/verification/:certificate_pack_id", "params": [ { "name": "certificate_pack_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method." }, { "info": { "name": "Cloudflare Get URL normalization settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/url_normalization", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetches the current URL normalization settings." }, { "info": { "name": "Cloudflare Update URL normalization settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/url_normalization", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the URL normalization settings." }, { "info": { "name": "Cloudflare List Filters", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/filters", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Cloudflare List Filters" }, { "info": { "name": "Cloudflare Create Filter", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/filters", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create Filter" }, { "info": { "name": "Cloudflare Update Filter", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/filters/:filter_id", "params": [ { "name": "filter_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Update Filter" }, { "info": { "name": "Cloudflare Delete Filter", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/filters/:filter_id", "params": [ { "name": "filter_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Filter" }, { "info": { "name": "Cloudflare List Routes", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/routes", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Returns routes for a zone." }, { "info": { "name": "Cloudflare Create Route", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/routes", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a route that maps a URL pattern to a Worker." }, { "info": { "name": "Cloudflare Get Route", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/routes/:route_id", "params": [ { "name": "route_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Returns information about a route, including URL pattern and Worker." }, { "info": { "name": "Cloudflare Update Route", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/routes/:route_id", "params": [ { "name": "route_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the URL pattern or Worker associated with a route." }, { "info": { "name": "Cloudflare Delete Route", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/routes/:route_id", "params": [ { "name": "route_id", "value": "", "type": "path" }, { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a route." }, { "info": { "name": "Cloudflare Download Worker", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/script", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Fetch raw script content for your worker. Note this is the original script content, not JSON encoded." }, { "info": { "name": "Cloudflare Upload Worker", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/script", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "Upload a worker, or a new version of a worker." }, { "info": { "name": "Cloudflare Delete Worker", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/script", "params": [ { "name": "zone_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete your Worker. This call has no response body on a successful delete." }, { "info": { "name": "Cloudflare List Bindings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_id/workers/script/bindings", "params": [ { "name": "zone_id", "value": "", "type": "path" } ] }, "docs": "List the bindings for a Workers script." }, { "info": { "name": "Cloudflare Get analytics by Co-locations", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/analytics/colos", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "until", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "continuous", "value": "", "type": "query" } ] }, "docs": "This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only." }, { "info": { "name": "Cloudflare Get dashboard", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/analytics/dashboard", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "until", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "continuous", "value": "", "type": "query" } ] }, "docs": "The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network." }, { "info": { "name": "Cloudflare List Available Plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/available_plans", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Lists available plans the zone can subscribe to." }, { "info": { "name": "Cloudflare Available Plan Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/available_plans/:plan_identifier", "params": [ { "name": "plan_identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Details of the available plan that the zone can subscribe to." }, { "info": { "name": "Cloudflare List Available Rate Plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/available_rate_plans", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Lists all rate plans the zone can subscribe to." }, { "info": { "name": "Cloudflare List custom pages", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/custom_pages", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches all the custom pages at the zone level." }, { "info": { "name": "Cloudflare Get a custom page", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/custom_pages/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a custom page." }, { "info": { "name": "Cloudflare Update a custom page", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/custom_pages/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of an existing custom page." }, { "info": { "name": "Cloudflare Get Email Routing settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Get information about the settings for your Email Routing zone." }, { "info": { "name": "Cloudflare Disable Email Routing", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/disable", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work." }, { "info": { "name": "Cloudflare Email Routing - DNS settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/dns", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Show the DNS records needed to configure your Email Routing zone." }, { "info": { "name": "Cloudflare Enable Email Routing", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/enable", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable you Email Routing zone. Add and lock the necessary MX and SPF records." }, { "info": { "name": "Cloudflare List routing rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" } ] }, "docs": "Lists existing routing rules." }, { "info": { "name": "Cloudflare Create routing rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address)." }, { "info": { "name": "Cloudflare Get routing rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules/:rule_identifier", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Get information for a specific routing rule already created." }, { "info": { "name": "Cloudflare Update routing rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules/:rule_identifier", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update actions and matches, or enable/disable specific routing rules." }, { "info": { "name": "Cloudflare Delete routing rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules/:rule_identifier", "params": [ { "name": "rule_identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Delete a specific routing rule." }, { "info": { "name": "Cloudflare Get catch-all rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules/catch_all", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Get information on the default catch-all routing rule." }, { "info": { "name": "Cloudflare Update catch-all rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/email/routing/rules/catch_all", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable catch-all routing rule, or change action to forward to specific destination address." }, { "info": { "name": "Cloudflare List filters", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "paused", "value": "", "type": "query" }, { "name": "expression", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "ref", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" } ] }, "docs": "Fetches filters in a zone. You can filter the results using several optional parameters." }, { "info": { "name": "Cloudflare Create filters", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more filters." }, { "info": { "name": "Cloudflare Update filters", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more existing filters." }, { "info": { "name": "Cloudflare Delete filters", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes one or more existing filters." }, { "info": { "name": "Cloudflare Get a filter", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a filter." }, { "info": { "name": "Cloudflare Update a filter", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing filter." }, { "info": { "name": "Cloudflare Delete a filter", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/filters/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing filter." }, { "info": { "name": "Cloudflare List Zone Lockdown rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/lockdowns", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "modified_on", "value": "", "type": "query" }, { "name": "ip", "value": "", "type": "query" }, { "name": "priority", "value": "", "type": "query" }, { "name": "uri_search", "value": "", "type": "query" }, { "name": "ip_range_search", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "created_on", "value": "", "type": "query" }, { "name": "description_search", "value": "", "type": "query" }, { "name": "ip_search", "value": "", "type": "query" } ] }, "docs": "Fetches Zone Lockdown rules. You can filter the results using several optional parameters." }, { "info": { "name": "Cloudflare Create a Zone Lockdown rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/lockdowns", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Zone Lockdown rule." }, { "info": { "name": "Cloudflare Get a Zone Lockdown rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/lockdowns/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a Zone Lockdown rule." }, { "info": { "name": "Cloudflare Update a Zone Lockdown rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/lockdowns/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing Zone Lockdown rule." }, { "info": { "name": "Cloudflare Delete a Zone Lockdown rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/lockdowns/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing Zone Lockdown rule." }, { "info": { "name": "Cloudflare List firewall rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "description", "value": "", "type": "query" }, { "name": "action", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "paused", "value": "", "type": "query" } ] }, "docs": "Fetches firewall rules in a zone. You can filter the results using several optional parameters." }, { "info": { "name": "Cloudflare Create firewall rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create one or more firewall rules." }, { "info": { "name": "Cloudflare Update firewall rules", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more existing firewall rules." }, { "info": { "name": "Cloudflare Update priority of firewall rules", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the priority of existing firewall rules." }, { "info": { "name": "Cloudflare Delete firewall rules", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes existing firewall rules." }, { "info": { "name": "Cloudflare Get a firewall rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query" } ] }, "docs": "Fetches the details of a firewall rule." }, { "info": { "name": "Cloudflare Update a firewall rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing firewall rule." }, { "info": { "name": "Cloudflare Update priority of a firewall rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the priority of an existing firewall rule." }, { "info": { "name": "Cloudflare Delete a firewall rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing firewall rule." }, { "info": { "name": "Cloudflare List User Agent Blocking rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/ua_rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description_search", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "ua_search", "value": "", "type": "query" } ] }, "docs": "Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters." }, { "info": { "name": "Cloudflare Create a User Agent Blocking rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/ua_rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new User Agent Blocking rule in a zone." }, { "info": { "name": "Cloudflare Get a User Agent Blocking rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/ua_rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a User Agent Blocking rule." }, { "info": { "name": "Cloudflare Update a User Agent Blocking rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/ua_rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing User Agent Blocking rule." }, { "info": { "name": "Cloudflare Delete a User Agent Blocking rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/ua_rules/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing User Agent Blocking rule." }, { "info": { "name": "Cloudflare List WAF overrides", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/overrides", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Fetches the URI-based WAF overrides in a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Create a WAF override", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/overrides", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a URI-based WAF override for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Get a WAF override", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Update WAF override", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Delete a WAF override", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare List WAF packages", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/packages", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "match", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" } ] }, "docs": "Fetches WAF packages for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Get a WAF package", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/packages/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare Update a WAF package", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/firewall/waf/packages/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/)." }, { "info": { "name": "Cloudflare List Health Checks", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "List configured health checks." }, { "info": { "name": "Cloudflare Create Health Check", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new health check." }, { "info": { "name": "Cloudflare Health Check Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetch a single configured health check." }, { "info": { "name": "Cloudflare Update Health Check", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a configured health check." }, { "info": { "name": "Cloudflare Patch Health Check", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch a configured health check." }, { "info": { "name": "Cloudflare Delete Health Check", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a health check." }, { "info": { "name": "Cloudflare Create Preview Health Check", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/preview", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new preview health check." }, { "info": { "name": "Cloudflare Health Check Preview Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/preview/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetch a single configured health check preview." }, { "info": { "name": "Cloudflare Delete Preview Health Check", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/healthchecks/preview/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a health check." }, { "info": { "name": "Cloudflare Get log retention flag", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/logs/control/retention/flag", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Gets log retention flag for Logpull API." }, { "info": { "name": "Cloudflare Update log retention flag", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/logs/control/retention/flag", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates log retention flag for Logpull API." }, { "info": { "name": "Cloudflare Get logs RayIDs", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/logs/rayids/:ray_identifier", "params": [ { "name": "ray_identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "timestamps", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" } ] }, "docs": "The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique)." }, { "info": { "name": "Cloudflare Get logs received", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/logs/received", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "end", "value": "", "type": "query" }, { "name": "sample", "value": "", "type": "query" }, { "name": "timestamps", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" } ] }, "docs": "The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is \"give me all the logs for zone Z for minute M\", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02" }, { "info": { "name": "Cloudflare List fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/logs/received/fields", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions." }, { "info": { "name": "Cloudflare List rate limits", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/rate_limits", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" } ] }, "docs": "Fetches the rate limits for a zone." }, { "info": { "name": "Cloudflare Create a rate limit", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/rate_limits", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes." }, { "info": { "name": "Cloudflare Get a rate limit", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/rate_limits/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the details of a rate limit." }, { "info": { "name": "Cloudflare Update a rate limit", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/rate_limits/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing rate limit." }, { "info": { "name": "Cloudflare Delete a rate limit", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/rate_limits/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing rate limit." }, { "info": { "name": "Cloudflare All Snippets", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare All Snippets" }, { "info": { "name": "Cloudflare Snippet", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets/:snippet_name", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "snippet_name", "value": "", "type": "path" } ] }, "docs": "Cloudflare Snippet" }, { "info": { "name": "Cloudflare Put Snippet", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets/:snippet_name", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "snippet_name", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "files", "type": "text", "value": "" }, { "name": "metadata", "type": "text", "value": "" } ] } }, "docs": "Cloudflare Put Snippet" }, { "info": { "name": "Cloudflare Delete Snippet", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets/:snippet_name", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "snippet_name", "value": "", "type": "path" } ] }, "docs": "Cloudflare Delete Snippet" }, { "info": { "name": "Cloudflare Snippet Content", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets/:snippet_name/content", "params": [ { "name": "zone_identifier", "value": "", "type": "path" }, { "name": "snippet_name", "value": "", "type": "path" } ] }, "docs": "Cloudflare Snippet Content" }, { "info": { "name": "Cloudflare Rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets/snippet_rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Rules" }, { "info": { "name": "Cloudflare Put Rules", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/snippets/snippet_rules", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Put Rules" }, { "info": { "name": "Cloudflare SSL/TLS Recommendation", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/ssl/recommendation", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Retrieve the SSL/TLS Recommender's recommendation for a zone." }, { "info": { "name": "Cloudflare List waiting rooms", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Lists waiting rooms." }, { "info": { "name": "Cloudflare Create waiting room", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new waiting room." }, { "info": { "name": "Cloudflare Waiting room details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single configured waiting room." }, { "info": { "name": "Cloudflare Update waiting room", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured waiting room." }, { "info": { "name": "Cloudflare Patch waiting room", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches a configured waiting room." }, { "info": { "name": "Cloudflare Delete waiting room", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a waiting room." }, { "info": { "name": "Cloudflare List events", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Lists events for a waiting room." }, { "info": { "name": "Cloudflare Create event", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time." }, { "info": { "name": "Cloudflare Event details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id", "params": [ { "name": "event_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches a single configured event for a waiting room." }, { "info": { "name": "Cloudflare Update event", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id", "params": [ { "name": "event_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a configured event for a waiting room." }, { "info": { "name": "Cloudflare Patch event", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id", "params": [ { "name": "event_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches a configured event for a waiting room." }, { "info": { "name": "Cloudflare Delete event", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id", "params": [ { "name": "event_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an event for a waiting room." }, { "info": { "name": "Cloudflare Preview active event details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/events/:event_id/details", "params": [ { "name": "event_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values." }, { "info": { "name": "Cloudflare List Waiting Room Rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/rules", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Lists rules for a waiting room." }, { "info": { "name": "Cloudflare Create Waiting Room Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/rules", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room." }, { "info": { "name": "Cloudflare Replace Waiting Room Rules", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/rules", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room." }, { "info": { "name": "Cloudflare Patch Waiting Room Rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches a rule for a waiting room." }, { "info": { "name": "Cloudflare Delete Waiting Room Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" }, { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a rule for a waiting room." }, { "info": { "name": "Cloudflare Get waiting room status", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/:waiting_room_id/status", "params": [ { "name": "waiting_room_id", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it sta" }, { "info": { "name": "Cloudflare Create a custom waiting room page preview", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/preview", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not a" }, { "info": { "name": "Cloudflare Get zone-level Waiting Room settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/settings", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Get zone-level Waiting Room settings" }, { "info": { "name": "Cloudflare Update zone-level Waiting Room settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/settings", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Update zone-level Waiting Room settings" }, { "info": { "name": "Cloudflare Patch zone-level Waiting Room settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/waiting_rooms/settings", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Patch zone-level Waiting Room settings" }, { "info": { "name": "Cloudflare List Web3 Hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare List Web3 Hostnames" }, { "info": { "name": "Cloudflare Create Web3 Hostname", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames", "params": [ { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create Web3 Hostname" }, { "info": { "name": "Cloudflare Web3 Hostname Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare Web3 Hostname Details" }, { "info": { "name": "Cloudflare Edit Web3 Hostname", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Edit Web3 Hostname" }, { "info": { "name": "Cloudflare Delete Web3 Hostname", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete Web3 Hostname" }, { "info": { "name": "Cloudflare IPFS Universal Path Gateway Content List Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare IPFS Universal Path Gateway Content List Details" }, { "info": { "name": "Cloudflare Update IPFS Universal Path Gateway Content List", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Update IPFS Universal Path Gateway Content List" }, { "info": { "name": "Cloudflare List IPFS Universal Path Gateway Content List Entries", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare List IPFS Universal Path Gateway Content List Entries" }, { "info": { "name": "Cloudflare Create IPFS Universal Path Gateway Content List Entry", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries", "params": [ { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Create IPFS Universal Path Gateway Content List Entry" }, { "info": { "name": "Cloudflare IPFS Universal Path Gateway Content List Entry Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier", "params": [ { "name": "content_list_entry_identifier", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ] }, "docs": "Cloudflare IPFS Universal Path Gateway Content List Entry Details" }, { "info": { "name": "Cloudflare Edit IPFS Universal Path Gateway Content List Entry", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier", "params": [ { "name": "content_list_entry_identifier", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Edit IPFS Universal Path Gateway Content List Entry" }, { "info": { "name": "Cloudflare Delete IPFS Universal Path Gateway Content List Entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone_identifier/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier", "params": [ { "name": "content_list_entry_identifier", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "path" }, { "name": "zone_identifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cloudflare Delete IPFS Universal Path Gateway Content List Entry" }, { "info": { "name": "Cloudflare Get current aggregated analytics", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/analytics/aggregate/current", "params": [ { "name": "zone", "value": "", "type": "path" }, { "name": "appID", "value": "", "type": "query" }, { "name": "app_id_param", "value": "", "type": "query" }, { "name": "colo_name", "value": "", "type": "query" } ] }, "docs": "Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone." }, { "info": { "name": "Cloudflare Get analytics by time", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/analytics/events/bytime", "params": [ { "name": "zone", "value": "", "type": "path" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "until", "value": "", "type": "query" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" }, { "name": "time_delta", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of aggregate metrics grouped by time interval." }, { "info": { "name": "Cloudflare Get analytics summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/analytics/events/summary", "params": [ { "name": "zone", "value": "", "type": "path" }, { "name": "dimensions", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "until", "value": "", "type": "query" }, { "name": "metrics", "value": "", "type": "query" }, { "name": "filters", "value": "", "type": "query" }, { "name": "since", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of summarised aggregate metrics over a given time period." }, { "info": { "name": "Cloudflare List Spectrum applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/apps", "params": [ { "name": "zone", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" } ] }, "docs": "Retrieves a list of currently existing Spectrum applications inside a zone." }, { "info": { "name": "Cloudflare Create Spectrum application using a name for the origin", "type": "http" }, "http": { "method": "POST", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/apps", "params": [ { "name": "zone", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Spectrum application from a configuration using a name for the origin." }, { "info": { "name": "Cloudflare Get Spectrum application configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "zone", "value": "", "type": "path" } ] }, "docs": "Gets the application configuration of a specific application inside a zone." }, { "info": { "name": "Cloudflare Update Spectrum application configuration using a name for the origin", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "zone", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a previously existing application's configuration that uses a name for the origin." }, { "info": { "name": "Cloudflare Delete Spectrum application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cloudflare.com/client/v4/zones/:zone/spectrum/apps/:app_id", "params": [ { "name": "app_id", "value": "", "type": "path" }, { "name": "zone", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a previously existing application." } ] } ], "bundled": true }