Cloudflare API

the cloudflare api connector enables automated interactions with cloudflare's services, allowing for programmatic management of security, performance, and dns settings cloudflare is a global network designed to make everything you connect to the internet secure, private, fast, and reliable the cloudflare api turbine connector allows users to automate interactions with cloudflare services, streamlining security operations by leveraging cloudflare's extensive capabilities directly within swimlane turbine this integration empowers users to manage security settings, access detailed information, and perform bulk operations efficiently, enhancing their security posture and response times cloudflare is a web infrastructure and security company that provides services to improve the performance, security, and reliability of websites apis,and other internet services it acts as a content delivery network (cdn) and offers various cybersecurity solutions to protect websites from attacks like distributed denial of service (ddos), data breaches, and other malicious activities using the cloudflare api requires authentication so that cloudflare knows who is making requests and what permissions you have prerequisites to effectively utilize the cloudflare api connector within swimlane turbine, ensure you have the following prerequisites http bearer token authentication with the following parameters url the base url for the cloudflare api endpoint token a valid bearer token (such as a jwt) to authenticate api requests capabilities cloudflare api connector provides the following capabilities create a list create an account or zone ruleset create an account or zone ruleset rule create list items create zone create an access group create an access reusable policy delete a list delete an access reusable policy delete an account or zone ruleset delete an account or zone ruleset rule delete an account or zone ruleset version delete list items delete zone delete an access group and so on create an account or zone ruleset creates a ruleset https //developers cloudflare com/api/resources/rulesets/methods/create/ create an access reusable policy creates a new access reusable policy https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/create/ create an access group creates a new access group https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/create/ create zone creates a zone https //developers cloudflare com/api/resources/zones/methods/create/ delete an account or zone ruleset deletes all versions of an existing account or zone ruleset https //developers cloudflare com/api/resources/rulesets/methods/delete/ delete an access reusable policy deletes an access reusable policy https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/delete/ delete an access group deletes an access group https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/delete/ delete zone deletes an existing zone https //developers cloudflare com/api/resources/zones/methods/delete/ edit zone edits a zone https //developers cloudflare com/api/resources/zones/methods/edit/ get asn overview retrieve overview information for a specific asn within cloudflare, requiring 'account id' and 'asn' as path parameters get asn subnets retrieve subnets associated with a specific asn from cloudflare, requiring the account id and asn as path parameters get an account or zone entry point ruleset fetches the latest version of the account or zone entry point ruleset for a given phase https //developers cloudflare com/api/resources/rulesets/subresources/phases/methods/get/ get an account or zone entry point ruleset version fetches a specific version of an account or zone entry point ruleset https //developers cloudflare com/api/resources/rulesets/subresources/phases/subresources/versions/methods/get/ get an account or zone ruleset fetches the latest version of an account or zone ruleset https //developers cloudflare com/api/resources/rulesets/methods/get/ get domain details retrieve detailed information about a specific domain in cloudflare using the account id and domain name get domain history retrieve the history of a specific domain in cloudflare using the account id and domain name as inputs get multiple domain details retrieve details for multiple domains from cloudflare using the account id and domain parameters get whois record retrieve the whois record for a specified domain using the cloudflare api, requiring account id and domain parameters get an access reusable policy fetches a single access reusable policy https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/get/ get an access group fetches a single access group https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/get/ get zone details gets the zone details https //developers cloudflare com/api/resources/zones/methods/get/ list account or zone rulesets fetches all rulesets https //developers cloudflare com/api/resources/rulesets/methods/list/ list an account or zone entry point ruleset versions fetches the versions of an account or zone entry point ruleset https //developers cloudflare com/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/ list access reusable policies lists access reusable policies https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/list/ list access groups lists all access groups https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/list/ list zones lists, searches, sorts, and filters your zones https //developers cloudflare com/api/resources/zones/methods/list/ purge cached content purge all cached content https //developers cloudflare com/api/resources/cache/methods/purge/ rerun the activation check triggeres a new activation check for a pending zone https //developers cloudflare com/api/resources/zones/subresources/activation check/methods/trigger/ update an account or zone entry point ruleset updates an account or zone entry point ruleset, creating a new version https //developers cloudflare com/api/resources/rulesets/subresources/phases/methods/update/ update an access reusable policy updates a access reusable policy https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/update/ update an access group updates a configured access group https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/update/ notes for more information on cloudflare api https //developers cloudflare com/api configurations cloudflare api http bearer authentication authenticates using bearer token such as a jwt, etc configuration parameters parameter description type required url a url to the target host string required token the api key, token, etc string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get asn overview retrieve overview information for a specific autonomous system number (asn) in cloudflare using the provided 'account id' and 'asn' endpoint url /client/v4/accounts/{{account id}}/intel/asn/{{asn}} method get input argument name type required description path parameters account id string required identifier for the account path parameters asn number required autonomous system number input example {"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result asn number result of the operation result description string result of the operation result country string result of the operation result type string type of the resource success boolean whether the operation was successful errors array error message if any errors file name string name of the resource errors file string error message if any messages array response message messages file name string name of the resource messages file string response message output example {"status code" 200,"response headers" {"date" "mon, 23 sep 2024 06 48 23 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "8c7896b56e0279f2 hyd","cf cache status" "dynamic","access control allow origin" " ","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzuprkop1jvc9j; samesite=lax; path=/; expire ","vary" "accept encoding","access control allow headers" "content type, cf access client id, cf acc get asn subnets retrieve subnets associated with an asn in cloudflare, requiring the account id and asn as path parameters endpoint url /client/v4/accounts/{{account id}}/intel/asn/{{asn}}/subnets method get input argument name type required description path parameters account id string required identifier for the account path parameters asn number required autonomous system number input example {"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result asn number result of the operation result ip count total number result of the operation result subnets array result of the operation result count number result of the operation result page number result of the operation result per page number result of the operation success boolean whether the operation was successful errors array error message if any errors file name string name of the resource errors file string error message if any messages array response message messages file name string name of the resource messages file string response message output example {"status code" 200,"response headers" {"date" "mon, 23 sep 2024 06 52 25 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "8c789c9a581779f2 hyd","cf cache status" "dynamic","access control allow origin" " ","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzumx1nateewih; samesite=lax; path=/; expire ","vary" "accept encoding","access control allow headers" "content type, cf access client id, cf acc get domain details retrieve detailed information for a specific domain in cloudflare using the provided account id and domain name endpoint url /client/v4/accounts/{{account id}}/intel/domain method get input argument name type required description path parameters account id string required identifier for the account parameters domain string required domain name to get details input example {"parameters" {"domain" "example com"},"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result domain string result of the operation result resolves to refs array result of the operation result resolves to refs id string unique identifier result resolves to refs value string value for the parameter result application object result of the operation result content categories array response content result content categories id number unique identifier result content categories super category id number unique identifier result content categories name string name of the resource result additional information object result of the operation result type string type of the resource result notes string result of the operation success boolean whether the operation was successful errors array error message if any errors file name string name of the resource errors file string error message if any messages array response message messages file name string name of the resource messages file string response message output example {"status code" 200,"response headers" {"date" "mon, 23 sep 2024 07 03 00 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "8c78ac121cb979f2 hyd","cf cache status" "dynamic","access control allow origin" " ","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzulmj4t9tuqc9; samesite=lax; path=/; expire ","vary" "accept encoding","access control allow headers" "content type, cf access client id, cf acc get domain history retrieve historical data for a domain in cloudflare using the account id and specified domain name endpoint url /client/v4/accounts/{{account id}}/intel/domain history method get input argument name type required description path parameters account id string required identifier of the account parameters domain string required domain to get history for input example {"parameters" {"domain" "example com"},"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation result domain string result of the operation result categorizations array result of the operation result categorizations categories array result of the operation result categorizations categories id number unique identifier result categorizations categories name string name of the resource result categorizations start string result of the operation result categorizations end string result of the operation success boolean whether the operation was successful errors array error message if any errors file name string name of the resource errors file string error message if any messages array response message messages file name string name of the resource messages file string response message output example {"status code" 200,"response headers" {"date" "mon, 23 sep 2024 07 09 11 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "8c78b52dcc6179f2 hyd","cf cache status" "dynamic","access control allow origin" " ","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzujwhgatkxu89; samesite=lax; path=/; expire ","vary" "accept encoding","access control allow headers" "content type, cf access client id, cf acc get multiple domain details retrieve details for multiple domains from cloudflare using a specified account id and domain parameters endpoint url /client/v4/accounts/{{account id}}/intel/domain/bulk method get input argument name type required description path parameters account id string required identifier for the account parameters domain array required multiple domains separated by ampersand input example {"parameters" {"domain" \["example com","example org"]},"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation result domain string result of the operation result application object result of the operation result content categories array response content result content categories id number unique identifier result content categories super category id number unique identifier result content categories name string name of the resource result additional information object result of the operation result type string type of the resource result notes string result of the operation success boolean whether the operation was successful errors array error message if any errors file name string name of the resource errors file string error message if any messages array response message messages file name string name of the resource messages file string response message output example {"status code" 200,"response headers" {"date" "mon, 23 sep 2024 07 24 41 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "8c78cbda0f5579f2 hyd","cf cache status" "dynamic","access control allow origin" " ","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzuq36qzci2p2v; samesite=lax; path=/; expire ","vary" "accept encoding","access control allow headers" "content type, cf access client id, cf acc get whois record retrieve the whois record for a specified domain using the cloudflare api, requiring account id and domain as parameters endpoint url /client/v4/accounts/{{account id}}/intel/whois method get input argument name type required description path parameters account id string required identifier for the account parameters domain string required domain to get whois record input example {"parameters" {"domain" "example com"},"path parameters" {"account id" "01a7362d577a6c3019a474fd6f485823"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result found boolean result of the operation result domain string result of the operation result dnssec boolean result of the operation result nameservers array name of the resource result registrar string result of the operation result registrant string result of the operation result id string unique identifier result punycode string result of the operation result name string name of the resource result extension string result of the operation result whois server string result of the operation result status array status value result created date string result of the operation result created date raw string result of the operation result updated date string result of the operation result updated date raw string result of the operation result expiration date string result of the operation result expiration date raw string result of the operation result registrar referral url string url endpoint for the request result registrar name string name of the resource success boolean whether the operation was successful errors array error message if any output example {"status code" 200,"response headers" {"date" "mon, 23 sep 2024 07 29 27 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "8c78d2dfbd6479f2 hyd","cf cache status" "dynamic","content encoding" "gzip","set cookie" " cf bm=wx58uusf6kdvqq lob5si5sgphampordwfjlgu2pn08 1727076567 1 0 1 1 wpc0ngeu8 ","vary" "accept encoding","cf auditlog id" "01921dc9 07f2 7974 a2db c49d620dfefe","server" "cloudflare"},"reason" "ok","json body" {" create a list creates a new list within cloudflare for a specified account, requiring path parameters and body details endpoint url /accounts/{{account id}}/rules/lists method post input argument name type required description path parameters account id string required the account id for this resource body object required request body body kind string required the type of the list each type supports specific list items (ip addresses, asns, hostnames or redirects) body name string required an informative name for the list use this name in filter and rule expressions body description string optional an informative summary of the list input example {"path parameters" {"account id" "string"},"body" {"kind" "string","name" "example name","description" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result description string result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "ip","name" "list1","description" "this is a note"},"success"\ true}} create an access group creates a new access group in cloudflare with inclusion rules using the provided account or zone id endpoint url /{{accounts or zones}}/{{account id or zone id}}/access/groups method post input argument name type required description path parameters account id or zone id string required identifier for the account or zone path parameters accounts or zones string required the type of account or zone include array optional rules evaluated with an or logical operator a user needs to meet only one of the include rules include group object optional parameter for create an access group include group id string optional unique identifier exclude array optional rules evaluated with a not logical operator to match a policy, a user cannot meet any of the exclude rules exclude group object optional parameter for create an access group exclude group id string optional unique identifier name string optional the name of the access group is default boolean optional whether this is the default group require array optional rules evaluated with an and logical operator to match a policy, a user must meet all of the require rules require group object optional parameter for create an access group require group id string optional unique identifier input example {"parameters" {},"json body" {"include" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"exclude" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"name" "allow devs","is default"\ false,"require" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}]},"path parameters" {"account id or zone id" "023e105f4ecef8ad9ca31a8372d0c353","accounts or zones" "zones"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result exclude array result of the operation result exclude group object result of the operation result exclude group id string unique identifier result include array result of the operation result include group object result of the operation result include group id string unique identifier result is default array result of the operation result is default group object result of the operation result is default group id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"exclude" \[],"include" \[],"is default" \[],"name" "allow devs","require" \[]}}} create an access reusable policy creates a new reusable policy in cloudflare access using account id, decision, include, and name endpoint url /accounts/{{account id}}/access/policies method post input argument name type required description path parameters account id string required unique identifier for the account decision string optional the action access will take if a user matches this policy infrastructure application policies can only use the allow action include array optional rules evaluated with an or logical operator a user needs to meet only one of the include rules include group object optional parameter for create an access reusable policy include group id string optional unique identifier name string optional the name of the access policy approval groups array optional administrators who can approve a temporary authentication request approval groups approvals needed number optional parameter for create an access reusable policy approval groups email addresses array optional parameter for create an access reusable policy approval groups email list uuid string optional unique identifier approval required boolean optional requires the user to request access from an administrator at the start of each session purpose justification prompt string optional a custom message that will appear on the purpose justification screen purpose justification required boolean optional require users to enter a justification when they log in to the application exclude array optional rules evaluated with a not logical operator to match the policy, a user cannot meet any of the exclude rules exclude group object optional parameter for create an access reusable policy exclude group id string optional unique identifier require array optional rules evaluated with an and logical operator to match the policy, a user must meet all of the require rules require group object optional parameter for create an access reusable policy require group id string optional unique identifier session duration string optional the amount of time that tokens issued for the application will be valid input example {"json body" {"decision" "allow","include" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"name" "allow devs","approval groups" \[{"approvals needed" 1,"email addresses" \["test1\@cloudflare com","test2\@cloudflare com"]},{"approvals needed" 3,"email list uuid" "597147a1 976b 4ef2 9af0 81d5d007fc34"}],"approval required"\ true,"isolation reqired"\ false,"purpose justification prompt" "please enter a justification for entering this protected domain ","purpose justification required"\ true,"exclude" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"require" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"session duration" "24h"},"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result app count number result of the operation result approval groups array result of the operation result approval groups approvals needed number result of the operation result approval groups email addresses array result of the operation result approval groups email list uuid string unique identifier result approval required boolean result of the operation result decision string result of the operation result exclude array result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415","app count" 2,"approval groups" \[],"approval required"\ true,"decision" "allow","exclude" \[],"include" \[],"isolation required"\ false,"name" "allow devs","purpose justification prompt" "please enter a justification for entering this protected domain ","purpose justification required"\ true,"require" \[],"reusable"\ true,"session duration" "24h"}}} create an account or zone ruleset creates a cloudflare ruleset for an account or zone using required path parameters and json body inputs like kind, name, and phase endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets method post input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters account id or zone id string required the id of the account or zone kind string optional the kind of the ruleset name string optional the human readable name of the ruleset minimum length is 1 character phase string optional the phase of the ruleset description string optional an informative description of the ruleset rules array optional the list of rules in the ruleset input example {"json body" {"kind" "zone","name" "my ruleset","phase" "http request firewall custom","description" "my ruleset to execute managed rulesets","rules" \[]},"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the create an account or zone ruleset action result rules action parameters response object parameters for the create an account or zone ruleset action result rules action parameters response content string parameters for the create an account or zone ruleset action result rules action parameters response content type string parameters for the create an account or zone ruleset action result rules action parameters response status code number parameters for the create an account or zone ruleset action result rules description string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} create an account or zone ruleset rule adds a new rule to a specified cloudflare account or zone ruleset using 'accounts or zones', 'ruleset id', and 'account or zone id' endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}}/rules method post input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the create an account or zone ruleset rule action result rules action parameters response object parameters for the create an account or zone ruleset rule action result rules action parameters response content string parameters for the create an account or zone ruleset rule action result rules action parameters response content type string parameters for the create an account or zone ruleset rule action result rules action parameters response status code number parameters for the create an account or zone ruleset rule action result rules description string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} create list items appends new items to a specified list within cloudflare and initiates an asynchronous operation use the operation id with the get bulk operation status endpoint to track status endpoint url /accounts/{{account id}}/rules/lists/{{list id}}/items method post input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list input example {"json body" {"ip" "10 0 0 1","comment" "allow office ip"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {},"success"\ true}} create zone initiates a new dns zone creation in cloudflare with user provided account details and zone name endpoint url /zones method post input argument name type required description account object optional the account to which the zone belongs account id string optional unique identifier name string optional the domain name type string optional a full zone implies that dns is hosted with cloudflare a partial zone is typically a partner hosted zone or a cname setup input example {"json body" {"account" {"id" "1234567890abcdef1234567890abcdef"},"name" "example com","type" "full"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result account object result of the operation result account id string unique identifier result account name string name of the resource result meta object result of the operation result meta cdn only boolean result of the operation result meta custom certificate quota number result of the operation result meta dns only boolean result of the operation result meta foundation dns boolean result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "023e105f4ecef8ad9ca31a8372d0c353","account" {},"meta" {},"name" "example com","owner" {},"plan" {},"cname suffix" "cdn cloudflare com","paused"\ true,"permissions" \[],"tenant" {},"tenant unit" {},"type" "full","vanity name servers" \[]}}} delete a list removes a specified list along with all its items from cloudflare using the account and list ids endpoint url /accounts/{{account id}}/rules/lists/{{list id}} method delete input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list input example {"path parameters" {"account id" "string","list id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {},"success"\ true}} delete an access group removes a specified access group from an account or zone in cloudflare using the provided account/zone and group ids endpoint url /{{accounts or zones}}/{{account id or zone id}}/access/groups/{{group id}} method delete input argument name type required description path parameters account id or zone id string required identifier for the account or zone path parameters accounts or zones string required the type of account or zone path parameters group id string required the uuid of the access group to delete input example {"path parameters" {"accounts or zones" "zones","account id or zone id" "023e105f4ecef8ad9ca31a8372d0c353","group id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {}}} delete an access reusable policy removes a specified access reusable policy from cloudflare using the provided account and policy ids endpoint url /accounts/{{account id}}/access/policies/{{policy id}} method delete input argument name type required description path parameters account id string required the unique identifier of the account path parameters policy id string required the uuid of the policy input example {"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353","policy id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415"}}} delete an account or zone ruleset deletes all versions of a specified account or zone ruleset in cloudflare api using the provided ruleset id endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets/{{ruleset id}} method delete input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters account id or zone id string required the unique identifier for the account or zone path parameters ruleset id string required the unique identifier for the ruleset input example {"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34","ruleset id" "8eb1584b2c3d40c69075c98b6a4d6ab7"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 204,"response headers" {"date" "wed, 11 jun 2025 13 08 47 gmt","connection" "keep alive","cf ray" "94e156cc3f743fa8 bom","cf cache status" "dynamic","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzu97urfe3pzjj; samesite=lax; path=/; expire ","vary" "accept encoding","api version" "2025 06 11","cf auditlog id" "01975f1b 7baf 7348 b77b 083ebae4ad6f","x version" "11412 5d5ca7e64450","server" "cloudflare"},"reason" "no content","response text" ""} delete an account or zone ruleset rule removes a specific rule from a cloudflare account or zone ruleset by utilizing the given ruleset and rule ids endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}}/rules/{{rule id}} method delete input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint path parameters rule id string required the unique id of the rule to delete input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string","rule id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the delete an account or zone ruleset rule action result rules action parameters response object parameters for the delete an account or zone ruleset rule action result rules action parameters response content string parameters for the delete an account or zone ruleset rule action result rules action parameters response content type string parameters for the delete an account or zone ruleset rule action result rules action parameters response status code number parameters for the delete an account or zone ruleset rule action result rules description string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} delete an account or zone ruleset version deletes a specific version of a cloudflare account or zone ruleset, requiring ruleset and version ids endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}}/versions/{{ruleset version}} method delete input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint path parameters ruleset version string required the version of the ruleset input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string","ruleset version" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the delete an account or zone ruleset version action result rules action parameters response object parameters for the delete an account or zone ruleset version action result rules action parameters response content string parameters for the delete an account or zone ruleset version action result rules action parameters response content type string parameters for the delete an account or zone ruleset version action result rules action parameters response status code number parameters for the delete an account or zone ruleset version action result rules description string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} delete list items removes specified items from a cloudflare list asynchronously use the operation id with the get bulk operation status endpoint to track status endpoint url /accounts/{{account id}}/rules/lists/{{list id}}/items method delete input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list body object required request body body items array optional list of items to remove from the list body items id string optional defines the unique id of the item in the list input example {"path parameters" {"account id" "string","list id" "string"},"body" {"items" \[{"id" "12345678 1234 1234 1234 123456789abc"}]}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {},"success"\ true}} delete zone removes a specified zone from cloudflare's management using the unique 'zone id' endpoint url /zones/{{zone id}} method delete input argument name type required description path parameters zone id string required the unique identifier for the zone to be deleted input example {"path parameters" {"zone id" "str023e105f4ecef8ad9ca31a8372d0c353ing"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "023e105f4ecef8ad9ca31a8372d0c353"}}} edit zone modify a specific zone's configuration in cloudflare using the provided zone id endpoint url /zones/{{zone id}} method patch input argument name type required description path parameters zone id string required the unique identifier for the zone to be edited paused boolean optional indicates whether the zone is only using cloudflare dns services type string optional a full zone implies that dns is hosted with cloudflare vanity name servers array optional an array of domains used for custom name servers this is only available for business and enterprise plans input example {"json body" {"paused"\ false,"type" "","vanity name servers" \["example com"]},"path parameters" {"zone id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result account object result of the operation result account id string unique identifier result account name string name of the resource result meta object result of the operation result meta cdn only boolean result of the operation result meta custom certificate quota number result of the operation result meta dns only boolean result of the operation result meta foundation dns boolean result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "023e105f4ecef8ad9ca31a8372d0c353","account" {},"meta" {},"name" "example com","owner" {},"plan" {},"cname suffix" "cdn cloudflare com","paused"\ true,"permissions" \[],"tenant" {},"tenant unit" {},"type" "full","vanity name servers" \[]}}} edit zone setting updates a specific zone setting in cloudflare using the provided zone id and setting id endpoint url client/v4/zones/{{zone id}}/settings/{{setting id}} method patch input argument name type required description path parameters zone id string required the unique identifier for the zone path parameters setting id string required the unique identifier for the setting enabled boolean optional parameter for edit zone setting value object optional value for the parameter input example {"json body" {"enabled"\ true,"value" {}},"path parameters" {"zone id" "test zone id","setting id" "test setting id"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result value string value for the parameter output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "0rtt","value" "on"}}} get a list retrieves details for a specified list using account and list ids in cloudflare api endpoint url /accounts/{{account id}}/rules/lists/{{list id}} method get input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list input example {"path parameters" {"account id" "string","list id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result description string result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "ip","name" "list1","description" "this is a note"},"success"\ true}} get a list item fetches a specific item from a list in cloudflare using account, list, and item ids endpoint url /accounts/{{account id}}/rules/lists/{{list id}}/items/{{item id}} method get input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list path parameters item id string required defines the unique id of the item in the list input example {"path parameters" {"account id" "string","list id" "string","item id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation result ip string result of the operation result comment string result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"ip" "10 0 0 1","comment" "private ip address"},"success"\ true}} get an access group fetches a specific access group from cloudflare using the provided account or zone id and group id endpoint url /{{accounts or zones}}/{{account id or zone id}}/access/groups/{{group id}} method get input argument name type required description path parameters account id or zone id string required identifier for the account or zone path parameters accounts or zones string required the type of account or zone path parameters group id string required the uuid of the access group to delete input example {"path parameters" {"account id or zone id" "023e105f4ecef8ad9ca31a8372d0c353","accounts or zones" "zones","group id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result exclude array result of the operation result exclude group object result of the operation result exclude group id string unique identifier result include array result of the operation result include group object result of the operation result include group id string unique identifier result is default array result of the operation result is default group object result of the operation result is default group id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"exclude" \[],"include" \[],"is default" \[],"name" "allow devs","require" \[]}}} get an access reusable policy retrieves a specific cloudflare access reusable policy using the provided account and policy ids endpoint url /accounts/{{account id}}/access/policies/{{policy id}} method get input argument name type required description path parameters account id string required unique identifier for the account path parameters policy id string required the uuid of the policy input example {"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353","policy id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result app count number result of the operation result approval groups array result of the operation result approval groups approvals needed number result of the operation result approval groups email addresses array result of the operation result approval groups email list uuid string unique identifier result approval required boolean result of the operation result decision string result of the operation result exclude array result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415","app count" 2,"approval groups" \[],"approval required"\ true,"decision" "allow","exclude" \[],"include" \[],"isolation required"\ false,"name" "allow devs","purpose justification prompt" "please enter a justification for entering this protected domain ","purpose justification required"\ true,"require" \[],"reusable"\ true,"session duration" "24h"}}} get an account or zone entry point ruleset retrieves the latest version of an account or zone entry point ruleset in cloudflare for a specified phase, requiring path parameters endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets/phases/{{ruleset phase}}/entrypoint method get input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters account id or zone id string required identifier for the account or zone path parameters ruleset phase string required the phase of the ruleset input example {"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34","ruleset phase" "http request firewall custom"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the get an account or zone entry point ruleset action result rules action parameters response object parameters for the get an account or zone entry point ruleset action result rules action parameters response content string parameters for the get an account or zone entry point ruleset action result rules action parameters response content type string parameters for the get an account or zone entry point ruleset action result rules action parameters response status code number parameters for the get an account or zone entry point ruleset action result rules description string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} get an account or zone entry point ruleset version retrieves a specific version of an account or zone entry point ruleset in cloudflare, detailing the phase and version endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets/phases/{{ruleset phase}}/entrypoint/versions/{{ruleset version}} method get input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters account id or zone id string required the unique identifier for the account or zone path parameters ruleset phase string required the phase of the ruleset path parameters ruleset version string required the version of the ruleset to fetch input example {"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34","ruleset phase" "http request firewall custom","ruleset version" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result description string result of the operation result id string unique identifier result kind string result of the operation result last updated string result of the operation result name string name of the resource result phase string result of the operation result source string result of the operation result version string result of the operation success boolean whether the operation was successful errors array error message if any messages array response message output example {"status code" 200,"response headers" {"date" "wed, 11 jun 2025 12 39 58 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "94e12c9bbb653fa8 bom","cf cache status" "dynamic","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzukpfhr7jpeih; samesite=lax; path=/; expire ","vary" "accept encoding","api version" "2025 06 11","cf auditlog id" "01975f01 1d69 79c5 9f54 5247a71dbb7b","x version" "11412 5d5ca get an account or zone ruleset retrieves the latest version of a specified ruleset for an account or zone in cloudflare, requiring path parameters like accounts or zones, account id or zone id, and ruleset id endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets/{{ruleset id}} method get input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters account id or zone id string required the unique identifier for the account or zone path parameters ruleset id string required the unique identifier for the ruleset input example {"path parameters" {"accounts or zones" "accounts","account id or zone id" "6560bc49a6a34abd353a8d4335702c23","ruleset id" "77454fe2d30c4220b5701f6fdfb893ba"}} output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation result description string result of the operation result id string unique identifier result kind string result of the operation result last updated string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules action string result of the operation result rules categories array result of the operation result rules description string result of the operation result rules enabled boolean result of the operation result rules id string unique identifier result rules last updated string result of the operation result rules ref string result of the operation result rules version string result of the operation result source string result of the operation result version string result of the operation success boolean whether the operation was successful errors array error message if any messages array response message output example {"status code" 200,"response headers" {"date" "wed, 11 jun 2025 13 02 10 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "94e14d1bec523fa8 bom","cf cache status" "dynamic","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzuumpyvzjeptd; samesite=lax; path=/; expire ","vary" "accept encoding","api version" "2025 06 11","cf auditlog id" "01975f15 6d80 7261 a0df 2c55a38d39e5","x version" "11412 5d5ca get an account or zone ruleset version retrieves a specific version of a cloudflare account or zone ruleset using the provided ruleset id and version number endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}}/versions/{{ruleset version}} method get input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint path parameters ruleset version string required the version of the ruleset input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string","ruleset version" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the get an account or zone ruleset version action result rules action parameters response object parameters for the get an account or zone ruleset version action result rules action parameters response content string parameters for the get an account or zone ruleset version action result rules action parameters response content type string parameters for the get an account or zone ruleset version action result rules action parameters response status code number parameters for the get an account or zone ruleset version action result rules description string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} get bulk operation status retrieve the status of an asynchronous bulk operation in cloudflare using account and operation ids endpoint url /accounts/{{account id}}/rules/lists/bulk operations/{{operation id}} method get input argument name type required description path parameters account id string required the account id for this resource path parameters operation id string required the unique operation id of the asynchronous action input example {"path parameters" {"account id" "string","operation id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {},"success"\ true}} get ip lists retrieves a list of ip addresses associated with the specified account id from cloudflare endpoint url /accounts/{{account id}}/intel/ip list method get input argument name type required description path parameters account id string required identifier input example {"path parameters" {"account id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result array result of the operation result id number unique identifier result description string result of the operation result name string name of the resource success boolean whether the operation was successful result info object result of the operation result info count number result of the operation result info page number result of the operation result info per page number result of the operation result info total count number result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" \[{}],"success"\ true,"result info" {"count" 1,"page" 1,"per page" 20,"total count" 2000}}} get list items retrieves all items from a specified list within cloudflare using the account and list ids endpoint url /accounts/{{account id}}/rules/lists/{{list id}}/items method get input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list query parameters cursor string optional the pagination cursor an opaque string token indicating the position from which to continue when requesting the next/previous set of records query parameters per page number optional amount of results to include in each paginated response a non negative 32 bit integer query parameters search string optional a search query to filter returned items its meaning depends on the list type input example {"path parameters" {"account id" "string","list id" "string"},"query parameters" {"cursor" "string","per page" 123,"search" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result array result of the operation result ip string result of the operation result comment string result of the operation success boolean whether the operation was successful result info object result of the operation result info cursors object result of the operation result info cursors after string result of the operation result info cursors before string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" \[{}],"success"\ true,"result info" {"cursors" {}}}} get lists retrieves all lists associated with a specified account id in cloudflare endpoint url /accounts/{{account id}}/rules/lists method get input argument name type required description path parameters account id string required the account id for this resource input example {"path parameters" {"account id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result array result of the operation result kind string result of the operation result name string name of the resource result description string result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" \[{}],"success"\ true}} get zone setting retrieve a specific zone setting from cloudflare api using the provided zone and setting ids endpoint url client/v4/zones/{{zone id}}/settings/{{setting id}} method get input argument name type required description path parameters zone id string required the unique identifier for the zone path parameters setting id string required the unique identifier for the setting input example {"path parameters" {"zone id" "test zone id","setting id" "test setting id"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result value string value for the parameter output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "0rtt","value" "on"}}} list access groups retrieves all access groups for a specified cloudflare account or zone using the provided account id or zone id endpoint url /{{accounts or zones}}/{{account id or zone id}}/access/groups method get input argument name type required description parameters name string optional the name of the group parameters page number optional page number of results parameters per page number optional number of results per page parameters search string optional search for groups by other listed query parameters path parameters account id or zone id string required identifier for the account or zone path parameters accounts or zones string required the type of account or zone input example {"parameters" {"name" "get an access reusable policy","page" 0,"per page" 20,"search" "test"},"path parameters" {"account id or zone id" "023e105f4ecef8ad9ca31a8372d0c353","accounts or zones" "zones"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result array result of the operation result exclude array result of the operation result exclude group object result of the operation result exclude group id string unique identifier result include array result of the operation result include group object result of the operation result include group id string unique identifier result is default array result of the operation result is default group object result of the operation result is default group id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" \[{}],"result info" {"count" 1,"page" 1,"per page" 20,"total count" 2000}}} list access reusable policies retrieves a list of reusable access policies for an account in cloudflare api using the 'account id' parameter endpoint url /accounts/{{account id}}/access/policies method get input argument name type required description parameters page number optional page number of results parameters per page number optional number of results per page path parameters account id string required the unique identifier for the account input example {"parameters" {"page" 1,"per page" 20},"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result array result of the operation result id string unique identifier result app count number result of the operation result approval groups array result of the operation result approval groups approvals needed number result of the operation result approval groups email addresses array result of the operation result approval groups email list uuid string unique identifier result approval required boolean result of the operation result decision string result of the operation result exclude array result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" \[{}],"result info" {"count" 1,"page" 1,"per page" 20,"total count" 2000}}} list account or zone entry point ruleset versions fetches versions of a cloudflare account or zone entry point ruleset using specific path parameters endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets/phases/{{ruleset phase}}/entrypoint/versions method get input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters account id or zone id string required identifier for the account or zone path parameters ruleset phase string required the phase of the ruleset input example {"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34","ruleset phase" "http request firewall custom"}} output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation result description string result of the operation result id string unique identifier result kind string result of the operation result last updated string result of the operation result name string name of the resource result phase string result of the operation result source string result of the operation result version string result of the operation success boolean whether the operation was successful errors array error message if any messages array response message output example {"status code" 200,"response headers" {"date" "wed, 11 jun 2025 11 55 40 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "94e0ebb4393c3fa8 bom","cf cache status" "dynamic","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzuqeo3jfqn3ft; samesite=lax; path=/; expire ","vary" "accept encoding","api version" "2025 06 11","cf auditlog id" "01975ed8 8cb9 75a5 abf5 42f67908d093","x version" "11412 5d5ca list account or zone rulesets retrieves all rulesets for a specified cloudflare account or zone, requiring the account or zone id as a path parameter endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets method get input argument name type required description parameters cursor string optional cursor to use for the next page minimum length is 1 character parameters per page number optional the number of results to return per page minimum value is 1, maximum value is 50 path parameters accounts or zones string required the type of resource to query, either 'accounts' or 'zones' path parameters account id or zone id string required the id of the account or zone to query input example {"parameters" {"cursor" "dghpc2lzyw5legftcgxlcg","per page" 20},"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34"}} output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation result description string result of the operation result id string unique identifier result kind string result of the operation result last updated string result of the operation result name string name of the resource result phase string result of the operation result version string result of the operation result source string result of the operation success boolean whether the operation was successful errors array error message if any messages array response message output example {"status code" 200,"response headers" {"date" "wed, 11 jun 2025 10 42 22 gmt","content type" "application/json; charset=utf 8","transfer encoding" "chunked","connection" "keep alive","cf ray" "94e0805229b83fa8 bom","cf cache status" "dynamic","content encoding" "gzip","set cookie" " cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzugwfnkxrzujb; samesite=lax; path=/; expire ","vary" "accept encoding","api version" "2025 06 11","cf auditlog id" "01975e95 6f6a 7cfa 906f cbfb83dd52de","x version" "11412 5d5ca list an account or zone ruleset's versions fetches the versions of a specified cloudflare account or zone ruleset using the ruleset id and account/zone id endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}}/versions method get input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result array result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result description string result of the operation success boolean whether the operation was successful result info object result of the operation result info cursors object result of the operation result info cursors after string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" \[{}],"success"\ true,"result info" {"cursors" {}}}} list zones retrieve, search, sort, and filter a list of zones from the cloudflare account endpoint url /zones method get input argument name type required description parameters account object optional the account to list zones for parameters account id string optional parameters for the list zones action parameters account name string optional parameters for the list zones action parameters direction string optional direction to order zones parameters match string optional whether to match all search requirements or at least one (any) parameters name string optional a domain name parameters order string optional field to order zones by parameters page number optional page number of paginated results parameters per page number optional number of zones per page parameters status string optional specify a zone status to filter by input example {"parameters" {"account" {"id" "list zones","name" "list zones"},"direction" "asc","match" "any","name" "example com","order" "name","page" 1,"per page" 20,"status" "pending"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result array result of the operation result id string unique identifier result account object result of the operation result account id string unique identifier result account name string name of the resource result meta object result of the operation result meta cdn only boolean result of the operation result meta custom certificate quota number result of the operation result meta dns only boolean result of the operation result meta foundation dns boolean result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" \[{}],"result info" {"count" 1,"page" 1,"per page" 20,"total count" 2000,"total pages" 100}}} purge cached content clears all files from cloudflare's cache for a specified zone using the provided zone id endpoint url /zones/{{zone id}}/purge cache method post input argument name type required description path parameters zone id string required the unique identifier for the zone to purge cached content tags array optional purge with tags hosts array optional purge with hosts prefixes array optional purge with prefixes files array optional purge with either list of files or with list of url and header pairs purge everything boolean optional purge all cached content in the zone input example {"json body" {"tags" \["a cache tag"],"hosts" \["example com"],"prefixes" \["www example com/foo"],"files" \["http //www example com/css/styles css"],"purge everything"\ true},"path parameters" {"zone id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "023e105f4ecef8ad9ca31a8372d0c353"}}} rerun the activation check initiates a new activation check for a cloudflare zone in pending status using the provided 'zone id' endpoint url /zones/{{zone id}}/activation check method put input argument name type required description path parameters zone id string required the unique identifier for the zone to be checked input example {"path parameters" {"zone id" "str023e105f4ecef8ad9ca31a8372d0c353ing"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "023e105f4ecef8ad9ca31a8372d0c353"}}} update a list updates a specified list's description within cloudflare using account and list ids path parameters and body content are required endpoint url /accounts/{{account id}}/rules/lists/{{list id}} method put input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list body object required request body body description string optional an informative summary of the list input example {"path parameters" {"account id" "string","list id" "string"},"body" {"description" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result description string result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "ip","name" "list1","description" "this is a note"},"success"\ true}} update all list items removes and adds items to a specified list in cloudflare asynchronously use the operation id with the get bulk operation status endpoint for updates endpoint url /accounts/{{account id}}/rules/lists/{{list id}}/items method put input argument name type required description path parameters account id string required the account id for this resource path parameters list id string required the unique id of the list input example {"json body" {"ip" "10 0 0 1","comment" "allow office ip"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message result object result of the operation success boolean whether the operation was successful output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {},"success"\ true}} update an access group updates an existing cloudflare access group using account/zone id and group id, with options to include name and rules endpoint url /{{accounts or zones}}/{{account id or zone id}}/access/groups/{{group id}} method put input argument name type required description path parameters account id or zone id string required identifier for the account or zone path parameters accounts or zones string required the type of account or zone path parameters group id string required the uuid of the access group to delete include array optional rules evaluated with an or logical operator a user needs to meet only one of the include rules include group object optional parameter for update an access group include group id string optional unique identifier exclude array optional rules evaluated with a not logical operator to match a policy, a user cannot meet any of the exclude rules exclude group object optional parameter for update an access group exclude group id string optional unique identifier name string optional the name of the access group is default boolean optional whether this is the default group require array optional rules evaluated with an and logical operator to match a policy, a user must meet all of the require rules require group object optional parameter for update an access group require group id string optional unique identifier input example {"json body" {"include" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"exclude" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"name" "allow devs","is default"\ false,"require" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}]},"path parameters" {"account id or zone id" "023e105f4ecef8ad9ca31a8372d0c353","accounts or zones" "zones","group id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result exclude array result of the operation result exclude group object result of the operation result exclude group id string unique identifier result include array result of the operation result include group object result of the operation result include group id string unique identifier result is default array result of the operation result is default group object result of the operation result is default group id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"exclude" \[],"include" \[],"is default" \[],"name" "allow devs","require" \[]}}} update an access reusable policy updates an existing cloudflare access reusable policy using account id, policy id, and parameters such as decision, include, and name endpoint url /accounts/{{account id}}/access/policies/{{policy id}} method put input argument name type required description path parameters account id string required the account identifier path parameters policy id string required the uuid of the policy decision string optional the action access will take if a user matches this policy include array optional rules evaluated with an or logical operator a user needs to meet only one of the include rules include group object optional parameter for update an access reusable policy include group id string optional unique identifier name string optional the name of the access policy approval groups array optional administrators who can approve a temporary authentication request approval groups approvals needed number optional parameter for update an access reusable policy approval groups email addresses array optional parameter for update an access reusable policy approval groups email list uuid string optional unique identifier approval required boolean optional requires the user to request access from an administrator at the start of each session exclude array optional rules evaluated with a not logical operator to match the policy, a user cannot meet any of the exclude rules exclude group object optional parameter for update an access reusable policy exclude group id string optional unique identifier isolation required boolean optional require this application to be served in an isolated browser for users matching this policy purpose justification prompt string optional a custom message that will appear on the purpose justification screen purpose justification required boolean optional require users to enter a justification when they log in to the application require array optional rules evaluated with an and logical operator to match the policy, a user must meet all of the require rules require group object optional parameter for update an access reusable policy require group id string optional unique identifier session duration string optional the amount of time that tokens issued for the application will be valid input example {"json body" {"decision" "allow","include" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"name" "allow devs","approval groups" \[{"approvals needed" 1,"email addresses" \["test1\@cloudflare com","test2\@cloudflare com"]},{"approvals needed" 3,"email list uuid" "597147a1 976b 4ef2 9af0 81d5d007fc34"}],"approval required"\ true,"exclude" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"isolation required"\ false,"purpose justification prompt" "please enter a justification for entering this protected domain ","purpose justification required"\ true,"require" \[{"group" {"id" "aa0a4aab 672b 4bdb bc33 a59f1130a11f"}}],"session duration" "24h"},"path parameters" {"account id" "023e105f4ecef8ad9ca31a8372d0c353","policy id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result app count number result of the operation result approval groups array result of the operation result approval groups approvals needed number result of the operation result approval groups email addresses array result of the operation result approval groups email list uuid string unique identifier result approval required boolean result of the operation result decision string result of the operation result exclude array result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "f174e90a fafe 4643 bbbc 4a0ed4fc8415","app count" 2,"approval groups" \[],"approval required"\ true,"decision" "allow","exclude" \[],"include" \[],"isolation required"\ false,"name" "allow devs","purpose justification prompt" "please enter a justification for entering this protected domain ","purpose justification required"\ true,"require" \[],"reusable"\ true,"session duration" "24h"}}} update an account or zone entry point ruleset updates a cloudflare account or zone entry point ruleset with specified path details and json body parameters endpoint url client/v4/{{accounts or zones}}/{{account id or zone id}}/rulesets/phases/{{ruleset phase}}/entrypoint method put input argument name type required description path parameters accounts or zones string required the type of resource to target, either 'accounts' or 'zones' path parameters account id or zone id string required the unique identifier for the account or zone path parameters ruleset phase string required the phase of the ruleset to update description string optional an informative description of the ruleset name string optional the human readable name of the ruleset rules array optional a list of rules to be included in the ruleset input example {"json body" {"description" "my ruleset to execute managed rulesets","name" "my ruleset","rules" \[]},"path parameters" {"accounts or zones" "zones","account id or zone id" "b8a144539f69c46084f32c6818d79f34","ruleset phase" "http request firewall custom"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the update an account or zone entry point ruleset action result rules action parameters response object parameters for the update an account or zone entry point ruleset action result rules action parameters response content string parameters for the update an account or zone entry point ruleset action result rules action parameters response content type string parameters for the update an account or zone entry point ruleset action result rules action parameters response status code number parameters for the update an account or zone entry point ruleset action result rules description string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} update an account or zone ruleset updates a specified cloudflare account or zone ruleset using the 'ruleset id' and 'account or zone id' endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}} method put input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the update an account or zone ruleset action result rules action parameters response object parameters for the update an account or zone ruleset action result rules action parameters response content string parameters for the update an account or zone ruleset action result rules action parameters response content type string parameters for the update an account or zone ruleset action result rules action parameters response status code number parameters for the update an account or zone ruleset action result rules description string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} update an account or zone ruleset rule updates a specific rule within a cloudflare account or zone ruleset using the provided ruleset and rule ids endpoint url /{{accounts or zones}}/{{account or zone id}}/rulesets/{{ruleset id}}/rules/{{rule id}} method patch input argument name type required description path parameters accounts or zones string required the type of account or zone path parameters ruleset id string required the unique id of the ruleset path parameters account or zone id string required the account or zone id to use for this endpoint path parameters rule id string required the unique id of the rule to update input example {"path parameters" {"accounts or zones" "string","ruleset id" "string","account or zone id" "string","rule id" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors message string response message errors code number error message if any errors source object error message if any errors source pointer string error message if any messages array response message messages message string response message messages code number response message messages source object response message messages source pointer string response message result object result of the operation result kind string result of the operation result name string name of the resource result phase string result of the operation result rules array result of the operation result rules id string unique identifier result rules action string result of the operation result rules action parameters object parameters for the update an account or zone ruleset rule action result rules action parameters response object parameters for the update an account or zone ruleset rule action result rules action parameters response content string parameters for the update an account or zone ruleset rule action result rules action parameters response content type string parameters for the update an account or zone ruleset rule action result rules action parameters response status code number parameters for the update an account or zone ruleset rule action result rules description string result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"result" {"kind" "root","name" "my ruleset","phase" "http request firewall custom","rules" \[],"description" "my ruleset to execute managed rulesets"},"success"\ true}} zone details retrieve detailed information for a specific zone using the provided zone id in cloudflare endpoint url /zones/{{zone id}} method get input argument name type required description path parameters zone id string required the unique identifier for the zone input example {"path parameters" {"zone id" "023e105f4ecef8ad9ca31a8372d0c353"}} output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any errors code number error message if any errors message string response message errors documentation url string url endpoint for the request errors source object error message if any errors source pointer string error message if any messages array response message messages code number response message messages message string response message messages documentation url string url endpoint for the request messages source object response message messages source pointer string response message success boolean whether the operation was successful result object result of the operation result id string unique identifier result account object result of the operation result account id string unique identifier result account name string name of the resource result meta object result of the operation result meta cdn only boolean result of the operation result meta custom certificate quota number result of the operation result meta dns only boolean result of the operation result meta foundation dns boolean result of the operation output example {"status code" 200,"reason" "ok","json body" {"errors" \[{}],"messages" \[{}],"success"\ true,"result" {"id" "023e105f4ecef8ad9ca31a8372d0c353","account" {},"meta" {},"name" "example com","owner" {},"plan" {},"cname suffix" "cdn cloudflare com","paused"\ true,"permissions" \[],"tenant" {},"tenant unit" {},"type" "full","vanity name servers" \[]}}} response headers header description example access control allow headers http response header access control allow headers content type, cf access client id, cf access client secret access control allow methods http response header access control allow methods delete, get, options, put access control allow origin http response header access control allow origin api version http response header api version 2025 06 11 cf auditlog id http response header cf auditlog id 01975f15 6d80 7261 a0df 2c55a38d39e5 cf cache status http response header cf cache status dynamic cf ray http response header cf ray 94e12c9bbb653fa8 bom connection http response header connection keep alive content encoding http response header content encoding gzip content type the media type of the resource application/json; charset=utf 8 date the date and time at which the message was originated mon, 23 sep 2024 07 29 27 gmt server information about the software used by the origin server cloudflare set cookie http response header set cookie cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzuq36qzci2p2v; samesite=lax; path=/; expires=mon, 23 sep 24 09 54 42 gmt; httponly, cf bm=ed1bymgeoejhqbkxedce1ja8vpdkh1nxjibky 9jcrg 1727076281 1 0 1 1 u3z2pvj2ykchzaojdb0nyrbdf gapfe9sbd106e7zeb8bnkm zn4hyh0l1zv3sugkum3g lwrer7t10miykmjw; path=/; expires=mon, 23 sep 24 07 54 41 gmt; domain= api cloudflare com; httponly; secure; samesite=none, cfruid=783bf72ee35e3c60172f73819570af047b960423 1727076281; path=/; domain= api cloudflare com; httponly; secure; samesite=none transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding x version http response header x version 11412 5d5ca7e64450