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 click here https //developers cloudflare com/api/resources/rulesets/methods/create/ create an access reusable policy creates a new access reusable policy click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/create/ create an access group creates a new access group click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/create/ create zone creates a zone click here 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 click here https //developers cloudflare com/api/resources/rulesets/methods/delete/ delete an access reusable policy deletes an access reusable policy click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/delete/ delete an access group deletes an access group click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/delete/ delete zone deletes an existing zone click here https //developers cloudflare com/api/resources/zones/methods/delete/ edit zone edits a zone click here 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 click here 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 click here 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 click here 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 click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/get/ get an access group fetches a single access group click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/get/ get zone details gets the zone details click here https //developers cloudflare com/api/resources/zones/methods/get/ list account or zone rulesets fetches all rulesets click here 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 click here https //developers cloudflare com/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/ list access reusable policies lists access reusable policies click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/list/ list access groups lists all access groups click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/list/ list zones lists, searches, sorts, and filters your zones click here https //developers cloudflare com/api/resources/zones/methods/list/ purge cached content purge all cached content click here https //developers cloudflare com/api/resources/cache/methods/purge/ rerun the activation check triggeres a new activation check for a pending zone click here 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 click here https //developers cloudflare com/api/resources/rulesets/subresources/phases/methods/update/ update an access reusable policy updates a access reusable policy click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/policies/methods/update/ update an access group updates a configured access group click here https //developers cloudflare com/api/resources/zero trust/subresources/access/subresources/groups/methods/update/ 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 input argument name type required description account id string required identifier for the account asn number required autonomous system number output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation asn number output field asn description string output field description country string output field country type string type of the resource success boolean whether the operation was successful errors array error message if any file name string name of the resource file string output field file messages array response message file name string name of the resource file string output field file 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 access client secret", "access control allow methods" "delete, get, options, put", "cf auditlog id" "01921da3 6d75 7374 87bc 01f1c90fd589", "server" "cloudflare" }, "reason" "ok", "json body" { "result" {}, "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description account id string required identifier for the account asn number required autonomous system number output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation asn number output field asn ip count total number output field ip count total subnets array output field subnets count number count value page number output field page per page number output field per page success boolean whether the operation was successful errors array error message if any file name string name of the resource file string output field file messages array response message file name string name of the resource file string output field file 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 access client secret", "access control allow methods" "delete, get, options, put", "cf auditlog id" "01921da7 1c87 743f a112 9d4abc959c99", "server" "cloudflare" }, "reason" "ok", "json body" { "result" {}, "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description account id string required identifier for the account domain string required domain name to get details output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation domain string output field domain resolves to refs array output field resolves to refs id string unique identifier value string value for the parameter application object output field application content categories array response content id number unique identifier super category id number unique identifier name string name of the resource additional information object output field additional information type string type of the resource notes string output field notes success boolean whether the operation was successful errors array error message if any file name string name of the resource file string output field file messages array response message file name string name of the resource file string output field file 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 access client secret", "access control allow methods" "delete, get, options, put", "cf auditlog id" "01921db0 c77b 7086 addb 3ef2fdf51fc5", "server" "cloudflare" }, "reason" "ok", "json body" { "result" {}, "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description account id string required identifier of the account domain string required domain to get history for output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation domain string output field domain categorizations array output field categorizations categories array output field categories id number unique identifier name string name of the resource start string output field start end string output field end success boolean whether the operation was successful errors array error message if any file name string name of the resource file string output field file messages array response message file name string name of the resource file string output field file 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 access client secret", "access control allow methods" "delete, get, options, put", "cf auditlog id" "01921db6 78b3 7a7c a4b9 300e07ceddc1", "server" "cloudflare" }, "reason" "ok", "json body" { "result" \[], "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description account id string required identifier for the account domain array required multiple domains separated by ampersand output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation domain string output field domain application object output field application content categories array response content id number unique identifier super category id number unique identifier name string name of the resource additional information object output field additional information type string type of the resource notes string output field notes success boolean whether the operation was successful errors array error message if any file name string name of the resource file string output field file messages array response message file name string name of the resource file string output field file 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 access client secret", "access control allow methods" "delete, get, options, put", "cf auditlog id" "01921dc4 a470 7980 9539 fbe7722ee725", "server" "cloudflare" }, "reason" "ok", "json body" { "result" \[], "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description account id string required identifier for the account domain string required domain to get whois record output parameter type description parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation found boolean output field found domain string output field domain dnssec boolean output field dnssec nameservers array name of the resource registrar string output field registrar registrant string output field registrant id string unique identifier punycode string output field punycode name string name of the resource extension string output field extension whois server string output field whois server status array status value created date string date value created date raw string output field created date raw updated date string date value updated date raw string output field updated date raw expiration date string date value expiration date raw string output field expiration date raw registrar referral url string url endpoint for the request registrar name string name of the resource success boolean whether the operation was successful 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" { "result" {}, "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description account id string required the account id for this resource body object required request body kind string required the type of the list each type supports specific list items (ip addresses, asns, hostnames or redirects) name string required an informative name for the list use this name in filter and rule expressions description string optional an informative summary of the list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource description string output field description success boolean whether the operation was successful example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id or zone id string required identifier for the account or zone accounts or zones string required the type of account or zone include array required rules evaluated with an or logical operator a user needs to meet only one of the include rules group object optional parameter for create an access 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 group object optional parameter for create an access group id string optional unique identifier name string required 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 group object optional parameter for create an access group id string optional unique identifier output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation exclude array output field exclude group object output field group id string unique identifier include array output field include group object output field group id string unique identifier is default array output field is default group object output field group example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description account id string required unique identifier for the account decision string required the action access will take if a user matches this policy infrastructure application policies can only use the allow action include array required rules evaluated with an or logical operator a user needs to meet only one of the include rules group object optional parameter for create an access reusable policy id string optional unique identifier name string required the name of the access policy approval groups array optional administrators who can approve a temporary authentication request approvals needed number optional parameter for create an access reusable policy email addresses array optional parameter for create an access reusable policy 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 group object optional parameter for create an access reusable policy 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 group object optional parameter for create an access reusable policy id string optional unique identifier session duration string optional the amount of time that tokens issued for the application will be valid output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier app count number count value approval groups array output field approval groups approvals needed number output field approvals needed email addresses array output field email addresses email list uuid string unique identifier approval required boolean output field approval required decision string output field decision example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description accounts or zones string required the type of account or zone account id or zone id string required the id of the account or zone kind string required the kind of the ruleset name string required the human readable name of the ruleset minimum length is 1 character phase string required the phase of the ruleset description string optional an informative description of the ruleset rules array optional the list of rules in the ruleset output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the create an account or zone ruleset action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the create an account or zone ruleset rule action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list ip string optional an ipv4 address, an ipv4 cidr, an ipv6 address, or an ipv6 cidr redirect object optional the definition of the redirect hostname string optional hostname (a z, 0 9, , ) asn number optional defines a non negative 32 bit integer comment string optional defines an informative summary of the list item output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation success boolean whether the operation was successful 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 input argument name type required description account object required the account to which the zone belongs id string optional unique identifier name string required 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 output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier account object count value id string unique identifier name string name of the resource meta object output field meta cdn only boolean output field cdn only custom certificate quota number output field custom certificate quota dns only boolean output field dns only example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation success boolean whether the operation was successful 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 input argument name type required description account id or zone id string required identifier for the account or zone accounts or zones string required the type of account or zone group id string required the uuid of the access group to delete output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation 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 input argument name type required description account id string required the unique identifier of the account policy id string required the uuid of the policy output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description accounts or zones string required the type of account or zone account id or zone id string required the unique identifier for the account or zone ruleset id string required the unique identifier for the ruleset output parameter type description 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 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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint rule id string required the unique id of the rule to delete output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the delete an account or zone ruleset rule action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint ruleset version string required the version of the ruleset output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the delete an account or zone ruleset version action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list body object required request body items array optional list of items to remove from the list id string optional defines the unique id of the item in the list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation success boolean whether the operation was successful 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 input argument name type required description zone id string required the unique identifier for the zone to be deleted output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description 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 output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier account object count value id string unique identifier name string name of the resource meta object output field meta cdn only boolean output field cdn only custom certificate quota number output field custom certificate quota dns only boolean output field dns only example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description zone id string required the unique identifier for the zone 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 output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier value string value for the parameter example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource description string output field description success boolean whether the operation was successful example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list item id string required defines the unique id of the item in the list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation ip string output field ip comment string output field comment success boolean whether the operation was successful example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id or zone id string required identifier for the account or zone accounts or zones string required the type of account or zone group id string required the uuid of the access group to delete output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation exclude array output field exclude group object output field group id string unique identifier include array output field include group object output field group id string unique identifier is default array output field is default group object output field group example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description account id string required unique identifier for the account policy id string required the uuid of the policy output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier app count number count value approval groups array output field approval groups approvals needed number output field approvals needed email addresses array output field email addresses email list uuid string unique identifier approval required boolean output field approval required decision string output field decision example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description accounts or zones string required the type of account or zone account id or zone id string required identifier for the account or zone ruleset phase string required the phase of the ruleset output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the get an account or zone entry point ruleset action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description accounts or zones string required the type of account or zone account id or zone id string required the unique identifier for the account or zone ruleset phase string required the phase of the ruleset ruleset version string required the version of the ruleset to fetch output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation description string output field description id string unique identifier kind string output field kind last updated string output field last updated name string name of the resource phase string output field phase source string output field source version string output field version success boolean whether the operation was successful errors array error message if any messages array response message 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 5d5ca7e64450", "server" "cloudflare" }, "reason" "ok", "json body" { "result" {}, "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description accounts or zones string required the type of account or zone account id or zone id string required the unique identifier for the account or zone ruleset id string required the unique identifier for the ruleset output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result object result of the operation description string output field description id string unique identifier kind string output field kind last updated string output field last updated name string name of the resource phase string output field phase rules array output field rules action string output field action categories array output field categories description string output field description enabled boolean output field enabled id string unique identifier last updated string output field last updated ref string output field ref version string output field version source string output field source version string output field version success boolean whether the operation was successful errors array error message if any messages array response message 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 5d5ca7e64450", "server" "cloudflare" }, "reason" "ok", "json body" { "result" {}, "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint ruleset version string required the version of the ruleset output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the get an account or zone ruleset version action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id string required the account id for this resource operation id string required the unique operation id of the asynchronous action output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation success boolean whether the operation was successful 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 input argument name type required description account id string required identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result array result of the operation id number unique identifier description string output field description name string name of the resource success boolean whether the operation was successful result info object result of the operation count number count value page number output field page per page number output field per page total count number count value example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" \[], "success" true, "result info" {} } } ] 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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list 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 per page number optional amount of results to include in each paginated response a non negative 32 bit integer search string optional a search query to filter returned items its meaning depends on the list type output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result array result of the operation ip string output field ip comment string output field comment success boolean whether the operation was successful result info object result of the operation cursors object output field cursors after string output field after before string output field before example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" \[], "success" true, "result info" {} } } ] 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 input argument name type required description account id string required the account id for this resource output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result array result of the operation kind string output field kind name string name of the resource description string output field description success boolean whether the operation was successful 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 input argument name type required description zone id string required the unique identifier for the zone setting id string required the unique identifier for the setting output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier value string value for the parameter example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description name string optional the name of the group page number optional page number of results per page number optional number of results per page search string optional search for groups by other listed query parameters account id or zone id string required identifier for the account or zone accounts or zones string required the type of account or zone output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result array result of the operation exclude array output field exclude group object output field group id string unique identifier include array output field include group object output field group id string unique identifier is default array output field is default group object output field group example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" \[], "result info" {} } } ] 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 input argument name type required description page number optional page number of results per page number optional number of results per page account id string required the unique identifier for the account output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result array result of the operation id string unique identifier app count number count value approval groups array output field approval groups approvals needed number output field approvals needed email addresses array output field email addresses email list uuid string unique identifier approval required boolean output field approval required decision string output field decision example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" \[], "result info" {} } } ] 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 input argument name type required description accounts or zones string required the type of account or zone account id or zone id string required identifier for the account or zone ruleset phase string required the phase of the ruleset output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation description string output field description id string unique identifier kind string output field kind last updated string output field last updated name string name of the resource phase string output field phase source string output field source version string output field version success boolean whether the operation was successful errors array error message if any messages array response message 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 5d5ca7e64450", "server" "cloudflare" }, "reason" "ok", "json body" { "result" \[], "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description cursor string optional cursor to use for the next page minimum length is 1 character per page number optional the number of results to return per page minimum value is 1, maximum value is 50 accounts or zones string required the type of resource to query, either 'accounts' or 'zones' account id or zone id string required the id of the account or zone to query output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase result array result of the operation description string output field description id string unique identifier kind string output field kind last updated string output field last updated name string name of the resource phase string output field phase version string output field version source string output field source success boolean whether the operation was successful errors array error message if any messages array response message 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 5d5ca7e64450", "server" "cloudflare" }, "reason" "ok", "json body" { "result" \[], "success" true, "errors" \[], "messages" \[] } } ] 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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result array result of the operation kind string output field kind name string name of the resource phase string output field phase description string output field description success boolean whether the operation was successful result info object result of the operation cursors object output field cursors after string output field after example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" \[], "success" true, "result info" {} } } ] 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 input argument name type required description account object optional the account to list zones for id string optional unique identifier name string optional name of the resource direction string optional direction to order zones match string optional whether to match all search requirements or at least one (any) name string optional a domain name order string optional field to order zones by page number optional page number of paginated results per page number optional number of zones per page status string optional specify a zone status to filter by output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result array result of the operation id string unique identifier account object count value id string unique identifier name string name of the resource meta object output field meta cdn only boolean output field cdn only custom certificate quota number output field custom certificate quota dns only boolean output field dns only example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" \[], "result info" {} } } ] 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 input argument name type required description 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 output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description zone id string required the unique identifier for the zone to be checked output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list body object required request body description string optional an informative summary of the list output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource description string output field description success boolean whether the operation was successful example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description account id string required the account id for this resource list id string required the unique id of the list ip string optional an ipv4 address, an ipv4 cidr, an ipv6 address, or an ipv6 cidr redirect object optional the definition of the redirect hostname string optional hostname (a z, 0 9, , ) asn number optional defines a non negative 32 bit integer comment string optional defines an informative summary of the list item output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer result object result of the operation success boolean whether the operation was successful 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 input argument name type required description account id or zone id string required identifier for the account or zone accounts or zones string required the type of account or zone group id string required the uuid of the access group to delete include array required rules evaluated with an or logical operator a user needs to meet only one of the include rules group object optional parameter for update an access 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 group object optional parameter for update an access group id string optional unique identifier name string required 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 group object optional parameter for update an access group id string optional unique identifier output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation exclude array output field exclude group object output field group id string unique identifier include array output field include group object output field group id string unique identifier is default array output field is default group object output field group example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description account id string required the account identifier policy id string required the uuid of the policy decision string required the action access will take if a user matches this policy include array required rules evaluated with an or logical operator a user needs to meet only one of the include rules group object optional parameter for update an access reusable policy id string optional unique identifier name string required the name of the access policy approval groups array optional administrators who can approve a temporary authentication request approvals needed number optional parameter for update an access reusable policy email addresses array optional parameter for update an access reusable policy 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 group object optional parameter for update an access reusable policy 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 group object optional parameter for update an access reusable policy id string optional unique identifier session duration string optional the amount of time that tokens issued for the application will be valid output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier app count number count value approval groups array output field approval groups approvals needed number output field approvals needed email addresses array output field email addresses email list uuid string unique identifier approval required boolean output field approval required decision string output field decision example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 input argument name type required description accounts or zones string required the type of resource to target, either 'accounts' or 'zones' account id or zone id string required the unique identifier for the account or zone 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 output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the update an account or zone entry point ruleset action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the update an account or zone ruleset action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description accounts or zones string required the type of account or zone ruleset id string required the unique id of the ruleset account or zone id string required the account or zone id to use for this endpoint rule id string required the unique id of the rule to update output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any message string response message code number output field code source object output field source pointer string output field pointer messages array response message message string response message code number output field code source object output field source pointer string output field pointer result object result of the operation kind string output field kind name string name of the resource phase string output field phase rules array output field rules id string unique identifier action string output field action action parameters object parameters for the update an account or zone ruleset rule action response object output field response content string response content content type string type of the resource status code number http status code of the response example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "result" {}, "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 input argument name type required description zone id string required the unique identifier for the zone output parameter type description parameter type description status code number http status code of the response reason string response reason phrase errors array error message if any code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer messages array response message code number output field code message string response message documentation url string url endpoint for the request source object output field source pointer string output field pointer success boolean whether the operation was successful result object result of the operation id string unique identifier account object count value id string unique identifier name string name of the resource meta object output field meta cdn only boolean output field cdn only custom certificate quota number output field custom certificate quota dns only boolean output field dns only example \[ { "status code" 200, "reason" "ok", "json body" { "errors" \[], "messages" \[], "success" true, "result" {} } } ] 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 01975f01 1d69 79c5 9f54 5247a71dbb7b cf cache status http response header cf cache status dynamic cf ray http response header cf ray 8c789c9a581779f2 hyd 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 24 41 gmt server information about the software used by the origin server cloudflare set cookie http response header set cookie cflb=0h28vghxwvgaqtjugu4yfbdjqfw1pfzugwfnkxrzujb; samesite=lax; path=/; expires=wed, 11 jun 25 13 12 23 gmt; httponly, cf bm=lv3kaoisjywnarkoj1jsf2otbwqjhn736tpwcl6yxqu 1749638542 1 0 1 1 e8ktk0vslzr9lkwc9bl hidmyurteycwdofggpkr3qg0ypuy0bhvtdla7bwldzuslvjqxb fzswdufgsfvwvnf5uxtymysaharfpdy3jtro; path=/; expires=wed, 11 jun 25 11 12 22 gmt; domain= api cloudflare com; httponly; secure; samesite=none, cfuvid=mh3iu0f8imsuid2flqalkit7g4gx5vvatmnu 8c8jl8 1749638542133 0 0 1 1 604800000; 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 notes for more information on cloudflare api cloudflare api https //developers cloudflare com/api