config/RestApis/cloudflare.json
|
{ "GeneralInfo": { "Name": "CloudFlare", "Description": "Cloud Flare Rest API", "AuthorizationType": "CustomHeaders", "version": "v4", "Docs": "" }, "Requirements": { "Headers": [ { "Item1": "x-auth-email", "Item2": "x-auth-key" } ] }, "Services": { "Account Members": [ { "Operation": "List Members", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/accounts/{account_identifier}/members?per_page=50", "Description": "List all members of an account.", "Docs": "https://developers.cloudflare.com/api/operations/account-members-list-members" } ], "Accounts": [ { "Operation": "List Accounts", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/accounts", "Description": "List all accounts you have ownership or verified access to.", "Docs": "https://developers.cloudflare.com/api/operations/accounts-list-accounts" } ], "DNS Records for a Zone": [ { "Operation": "Create DNS Record", "Method": "POST", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/dns_records", "Description": "Create a new DNS record for a zone. See the record object definitions for required attributes for each record type.", "Docs": "https://api.cloudflare.com/#dns-records-for-a-zone-create-dns-record" }, { "Operation": "Delete DNS Record", "Method": "DELETE", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/dns_records/{recordid}", "Description": "Deletes a specific DNS record for a zone. See the record object definitions for required attributes for each record type.", "Docs": "https://api.cloudflare.com/#dns-records-for-a-zone-delete-dns-record" }, { "Operation": "List DNS Records", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/dns_records?per_page=5000", "Description": "List, search, sort, and filter a zones' DNS records.", "Docs": "https://api.cloudflare.com/#dns-records-for-a-zone-list-dns-records" }, { "Operation": "Update DNS Record", "Method": "Put", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/dns_records/{recordid}", "Description": "Updates a specific DNS record for a zone. See the record object definitions for required attributes for each record type.", "Docs": "https://api.cloudflare.com/#dns-records-for-a-zone-update-dns-record" } ], "Firewall Rules": [ { "Operation": "Get a firewall rule", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_identifier}/firewall/rules/{id}", "Description": "(Deprecated) Fetches the details of a firewall rule.", "Docs": "https://developers.cloudflare.com/api/operations/firewall-rules-get-a-firewall-rule" }, { "Operation": "List firewall rules", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_identifier}/firewall/rules", "Description": "(Deprecated) Fetches firewall rules in a zone. You can filter the results using several optional parameters.", "Docs": "https://developers.cloudflare.com/api/operations/firewall-rules-list-firewall-rules" } ], "Page Rules": [ { "Operation": "Get Page Rules", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/pagerules", "Description": "List, search, sort, and filter a zones' page rules.", "Docs": "https://api.cloudflare.com/#page-rules-for-a-zone-properties" } ], "Universal SSL Settings for a Zone": [ { "Operation": "Universal SSL Settings Details", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/ssl/universal/settings", "Description": "Get Universal SSL Settings for a Zone.", "Docs": "https://developers.cloudflare.com/api/operations/universal-ssl-settings-for-a-zone-universal-ssl-settings-details" } ], "Worker Routes": [ { "Operation": "List Routes", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_id}/workers/routes", "Description": "Returns routes for a zone.", "Docs": "https://developers.cloudflare.com/api/operations/worker-routes-list-routes" }, { "Operation": "Create Route", "Method": "POST", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_id}/workers/routes", "Description": "Creates a route that maps a URL pattern to a Worker.", "Docs": "https://developers.cloudflare.com/api/operations/worker-routes-create-route" }, { "Operation": "Delete Route", "Method": "DELETE", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_id}/workers/routes/{route_id}", "Description": "Deletes a route.", "Docs": "https://developers.cloudflare.com/api/operations/worker-routes-delete-route" }, { "Operation": "Get Route", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_id}/workers/routes/{route_id}", "Description": "Returns information about a route, including URL pattern and Worker.", "Docs": "https://developers.cloudflare.com/api/operations/worker-routes-get-route" }, { "Operation": "Update Route", "Method": "PUT", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_id}/workers/routes/{route_id}", "Description": "Updates the URL pattern or Worker associated with a route.", "Docs": "https://developers.cloudflare.com/api/operations/worker-routes-update-route" } ], "Zone": [ { "Operation": "List Zones", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones?per_page=1000", "Description": "List, search, sort, and filter your zones.", "Docs": "https://api.cloudflare.com/#zone-list-zones" } ], "Zone Rulesets": [ { "Operation": "Get custom rule sets by zone", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_identifier}/rulesets", "Description": "Fetches all rulesets at the zone level.", "Docs": "https://developers.cloudflare.com/api/operations/listZoneRulesets" }, { "Operation": "Get a custom rule set by zone and rule set id", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zone_identifier}/rulesets/{ruleset_id}", "Description": "Get a zone ruleset", "Docs": "https://developers.cloudflare.com/api/operations/getZoneRuleset" }, { "Operation": "Get a zone entry point ruleset", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/rulesets/phases/{ruleset_phase}/entrypoint", "Description": "Fetches the latest version of a zone entry point ruleset for a given phase..", "Docs": "https://api.cloudflare.com/#zone-rulesets-get-a-zone-entry-point-ruleset" } ], "Zone Settings": [ { "Operation": "Get Always Use HTTPS setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/always_use_https", "Description": "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.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-always-use-https-setting" }, { "Operation": "Get Automatic HTTPS Rewrites setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/automatic_https_rewrites", "Description": "Enable the Automatic HTTPS Rewrites feature for this zone.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-automatic-https-rewrites-setting" }, { "Operation": "Get HTTP2 setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/http2", "Description": "Value of the HTTP2 setting.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-h-t-t-p-2-setting" }, { "Operation": "Get HTTP3 setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/http3", "Description": "Value of the HTTP3 setting.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-h-t-t-p-3-setting" }, { "Operation": "Get HTTP/2 Edge Prioritization setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/h2_prioritization", "Description": "Gets HTTP/2 Edge Prioritization setting.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-h2_prioritization-setting" }, { "Operation": "Get Minimum TLS Version setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/min_tls_version", "Description": "Gets Minimum TLS Version setting.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-minimum-tls-version-setting" }, { "Operation": "Get Opportunistic Encryption setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/opportunistic_encryption", "Description": "Gets Opportunistic Encryption setting.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-opportunistic-encryption-setting" }, { "Operation": "Get Security Header (HSTS) setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/security_header", "Description": "Cloudflare security header for a zone.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-security-header-(-hsts)-setting" }, { "Operation": "Get TLS 1.3 setting enabled for a zone", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/settings/tls_1_3", "Description": "Gets TLS 1.3 setting enabled for a zone.", "Docs": "https://developers.cloudflare.com/api/operations/zone-settings-get-tls-1.-3-setting-enabled-for-a-zone" }, { "Operation": "Get Web Application Firewall (WAF) setting", "Method": "GET", "Uri": "https://api.cloudflare.com/client/{version}/zones/{zoneid}/settings/waf", "Description": "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 action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server.", "Docs": "https://api.cloudflare.com/#zone-settings-get-web-application-firewall-waf-setting" }, { "Operation": "Total TLS Settings Details", "Method": "GET", "Uri": "https://api.cloudflare.com/client/v4/zones/{zone_id}/acm/total_tls", "Description": "Get Total TLS Settings for a Zone.", "Docs": "https://developers.cloudflare.com/api/operations/total-tls-total-tls-settings-details" } ] } } |