Cloudflare Api

The Cloudflare API enables programmatic access to Cloudflare's suite of web performance and security tools.

Cloudflare is a leading web performance and security company that provides content delivery network services, internet security, and distributed domain name server services. The Cloudflare API connector allows Swimlane Turbine users to automate a wide range of security operations, including domain and ASN information retrieval, WHOIS record access, and DNS zone management. By integrating with Cloudflare, users can enhance their security automation capabilities, streamline threat intelligence gathering, and efficiently manage network resources, all without writing code.

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

Before you can use the Cloudflare API connector for Turbine, you'll need access to the Cloudflare API. This requires the following:

HTTP Bearer authentication using the following parameters:

URL: The endpoint URL for accessing Cloudflare API services.

Token: A valid bearer token for authenticating API requests, such as a JWT.

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.

Create An Access Reusable Policy

Creates a new Access reusable policy Click Here.

Create An Access Group

Creates a new Access group Click Here.

Create Zone

Creates a Zone Click Here

Delete An Account Or Zone Ruleset

Deletes all versions of an existing account or zone ruleset Click Here.

Delete An Access Reusable Policy

Deletes an Access reusable policy Click Here

Delete An Access Group

Deletes an Access group Click Here

Delete Zone

Deletes an existing Zone Click Here

Edit Zone

Edits a Zone Click Here

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.

Get An Account Or Zone Entry Point Ruleset Version

Fetches a specific version of an account or zone entry point ruleset Click Here.

Get An Account Or Zone Ruleset

Fetches the latest version of an account or zone ruleset Click Here.

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

Get An Access Group

Fetches a single Access group Click Here

Get Zone Details

Gets the Zone Details Click Here

List Account Or Zone Rulesets

Fetches all rulesets Click Here.

List An Account Or Zone Entry Point Ruleset Versions

Fetches the versions of an account or zone entry point ruleset Click Here.

List Access Reusable Policies

Lists Access reusable policies Click Here

List Access Groups

Lists all Access groups Click Here

List Zones

Lists, searches, sorts, and filters your zones Click Here

Purge Cached Content

Purge All Cached Content Click Here

Rerun The Activation Check

Triggeres a new activation check for a PENDING Zone Click Here

Update An Account Or Zone Entry Point Ruleset

Updates an account or zone entry point ruleset, creating a new version Click Here.

Update An Access Reusable Policy

Updates a Access reusable policy Click Here

Update An Access Group

Updates a configured Access group Click Here

Notes

For more information on CloudFlare API : Cloudflare API

Additional Documentation

Cloudflare Api Connector Documentation

Cloudflare Api API Documentation

Configurations

CloudFlare API HTTP Bearer Authentication

Authenticates using Bearer Token such as a JWT, etc.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the Target host.	string	Required
token	The API key, token, etc.	string	Required
verify_ssl	Verify SSL Certificate.	boolean	Optional
http_proxy	A Proxy to route Requests through.	string	Optional

Actions

Get ASN Overview

Retrieve overview information for a specific Autonomous System Number (ASN) in Cloudflare using the provided 'account_id' and 'asn'.

Endpoint

URL: /client/v4/accounts/{{account_id}}/intel/asn/{{asn}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier for the Account.
path_parameters.asn	number	Required	Autonomous System Number.

Input Example

{"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.asn	number	Result of the operation
result.description	string	Result of the operation
result.country	string	Result of the operation
result.type	string	Type of the resource
success	boolean	Whether the operation was successful
errors	array	Error message if any
errors.file_name	string	Name of the resource
errors.file	string	Error message if any
messages	array	Response message
messages.file_name	string	Name of the resource
messages.file	string	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 23 Sep 2024 06:48:23 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"8c7896b56e0279f2-HYD","CF-Cache-Status":"DYNAMIC","Access-Control-Allow-Origin":"*","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuPrkop1jVC9j; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","access-control-allow-headers":"Content-Type, Cf-Access-Client-Id, Cf-Acc...

Get ASN Subnets

Retrieve subnets associated with an ASN in Cloudflare, requiring the account ID and ASN as path parameters.

Endpoint

URL: /client/v4/accounts/{{account_id}}/intel/asn/{{asn}}/subnets

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier for the Account.
path_parameters.asn	number	Required	Autonomous System Number.

Input Example

{"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.asn	number	Result of the operation
result.ip_count_total	number	Result of the operation
result.subnets	array	Result of the operation
result.count	number	Result of the operation
result.page	number	Result of the operation
result.per_page	number	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
errors.file_name	string	Name of the resource
errors.file	string	Error message if any
messages	array	Response message
messages.file_name	string	Name of the resource
messages.file	string	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 23 Sep 2024 06:52:25 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"8c789c9a581779f2-HYD","CF-Cache-Status":"DYNAMIC","Access-Control-Allow-Origin":"*","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuMX1naTEEWiH; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","access-control-allow-headers":"Content-Type, Cf-Access-Client-Id, Cf-Acc...

Get Domain Details

Retrieve detailed information for a specific domain in Cloudflare using the provided account ID and domain name.

Endpoint

URL: /client/v4/accounts/{{account_id}}/intel/domain

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier for the Account.
parameters.domain	string	Required	Domain Name to get Details.

Input Example

{"parameters":{"domain":"example.com"},"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.domain	string	Result of the operation
result.resolves_to_refs	array	Result of the operation
result.resolves_to_refs.id	string	Unique identifier
result.resolves_to_refs.value	string	Value for the parameter
result.application	object	Result of the operation
result.content_categories	array	Response content
result.content_categories.id	number	Unique identifier
result.content_categories.super_category_id	number	Unique identifier
result.content_categories.name	string	Name of the resource
result.additional_information	object	Result of the operation
result.type	string	Type of the resource
result.notes	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
errors.file_name	string	Name of the resource
errors.file	string	Error message if any
messages	array	Response message
messages.file_name	string	Name of the resource
messages.file	string	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 23 Sep 2024 07:03:00 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"8c78ac121cb979f2-HYD","CF-Cache-Status":"DYNAMIC","Access-Control-Allow-Origin":"*","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuLMJ4t9tuqc9; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","access-control-allow-headers":"Content-Type, Cf-Access-Client-Id, Cf-Acc...

Get Domain History

Retrieve historical data for a domain in Cloudflare using the account ID and specified domain name.

Endpoint

URL: /client/v4/accounts/{{account_id}}/intel/domain-history

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier of the Account.
parameters.domain	string	Required	Domain to get History for.

Input Example

{"parameters":{"domain":"example.com"},"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	array	Result of the operation
result.domain	string	Result of the operation
result.categorizations	array	Result of the operation
result.categorizations.categories	array	Result of the operation
result.categorizations.categories.id	number	Unique identifier
result.categorizations.categories.name	string	Name of the resource
result.categorizations.start	string	Result of the operation
result.categorizations.end	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
errors.file_name	string	Name of the resource
errors.file	string	Error message if any
messages	array	Response message
messages.file_name	string	Name of the resource
messages.file	string	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 23 Sep 2024 07:09:11 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"8c78b52dcc6179f2-HYD","CF-Cache-Status":"DYNAMIC","Access-Control-Allow-Origin":"*","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuJWhGAtKxu89; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","access-control-allow-headers":"Content-Type, Cf-Access-Client-Id, Cf-Acc...

Get Multiple Domain Details

Retrieve details for multiple domains from Cloudflare using a specified account ID and domain parameters.

Endpoint

URL: /client/v4/accounts/{{account_id}}/intel/domain/bulk

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier for the Account.
parameters.domain	array	Required	Multiple Domains separated by Ampersand.

Input Example

{"parameters":{"domain":["example.com","example.org"]},"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	array	Result of the operation
result.domain	string	Result of the operation
result.application	object	Result of the operation
result.content_categories	array	Response content
result.content_categories.id	number	Unique identifier
result.content_categories.super_category_id	number	Unique identifier
result.content_categories.name	string	Name of the resource
result.additional_information	object	Result of the operation
result.type	string	Type of the resource
result.notes	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
errors.file_name	string	Name of the resource
errors.file	string	Error message if any
messages	array	Response message
messages.file_name	string	Name of the resource
messages.file	string	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 23 Sep 2024 07:24:41 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"8c78cbda0f5579f2-HYD","CF-Cache-Status":"DYNAMIC","Access-Control-Allow-Origin":"*","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuQ36qzci2P2V; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","access-control-allow-headers":"Content-Type, Cf-Access-Client-Id, Cf-Acc...

Get WHOIS Record

Retrieve the WHOIS record for a specified domain using the Cloudflare API. Requires account ID as a path parameter and domain as a parameter.

Endpoint

URL: /client/v4/accounts/{{account_id}}/intel/whois

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier for the Account.
parameters.domain	string	Required	Domain to get WHOIS Record.

Input Example

{"parameters":{"domain":"example.com"},"path_parameters":{"account_id":"01a7362d577a6c3019a474fd6f485823"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.found	boolean	Result of the operation
result.domain	string	Result of the operation
result.dnssec	boolean	Result of the operation
result.nameservers	array	Name of the resource
result.registrar	string	Result of the operation
result.registrant	string	Result of the operation
result.id	string	Unique identifier
result.punycode	string	Result of the operation
result.name	string	Name of the resource
result.extension	string	Result of the operation
result.whois_server	string	Result of the operation
result.status	array	Status value
result.created_date	string	Result of the operation
result.created_date_raw	string	Result of the operation
result.updated_date	string	Result of the operation
result.updated_date_raw	string	Result of the operation
result.expiration_date	string	Result of the operation
result.expiration_date_raw	string	Result of the operation
result.registrar_referral_url	string	URL endpoint for the request
result.registrar_name	string	Name of the resource
success	boolean	Whether the operation was successful
errors	array	Error message if any

Output Example

{"status_code":200,"response_headers":{"Date":"Mon, 23 Sep 2024 07:29:27 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"8c78d2dfbd6479f2-HYD","CF-Cache-Status":"DYNAMIC","Content-Encoding":"gzip","Set-Cookie":"__cf_bm=wX58uUsF6kDVQQ_Lob5sI5SgPHAMpORdwfjlGU2Pn08-1727076567-1.0.1.1-wPc0nGEU8...","Vary":"Accept-Encoding","cf-auditlog-id":"01921dc9-07f2-7974-a2db-c49d620dfefe","Server":"cloudflare"},"reason":"OK","json_body":{"...

Create A List

Create a new list within Cloudflare for a specified account, requiring account ID as path parameter and additional body details.

Endpoint

URL: /accounts/{{account_id}}/rules/lists

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
body	object	Required	Request Body
body.kind	string	Required	The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
body.name	string	Required	An informative name for the list. Use this name in filter and rule expressions.
body.description	string	Optional	An informative summary of the list.

Input Example

{"path_parameters":{"account_id":"string"},"body":{"kind":"string","name":"Example Name","description":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.description	string	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{"kind":"ip","name":"list1","description":"This is a note"},"success":true}}

Create an Access Group

Create a new Access group in Cloudflare using account or zone ID with specified inclusion rules.

Endpoint

URL: /{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/access/groups

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
include	array	Optional	Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
include.group	object	Optional	Parameter for Create an Access Group
include.group.id	string	Optional	Unique identifier
exclude	array	Optional	Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
exclude.group	object	Optional	Parameter for Create an Access Group
exclude.group.id	string	Optional	Unique identifier
name	string	Optional	The name of the Access group.
is_default	boolean	Optional	Whether this is the default group
require	array	Optional	Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
require.group	object	Optional	Parameter for Create an Access Group
require.group.id	string	Optional	Unique identifier

Input Example

{"parameters":{},"json_body":{"include":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"exclude":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"name":"Allow devs","is_default":false,"require":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}]},"path_parameters":{"account_ID_or_zone_ID":"023e105f4ecef8ad9ca31a8372d0c353","accounts_or_zones":"zones"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.exclude	array	Result of the operation
result.exclude.group	object	Result of the operation
result.exclude.group.id	string	Unique identifier
result.include	array	Result of the operation
result.include.group	object	Result of the operation
result.include.group.id	string	Unique identifier
result.is_default	array	Result of the operation
result.is_default.group	object	Result of the operation
result.is_default.group.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"exclude":[],"include":[],"is_default":[],"name":"Allow devs","require":[]}}}

Create an Access Reusable Policy

Create a new reusable policy in Cloudflare Access using account_id, decision, include, and name.

Endpoint

URL: /accounts/{{account_id}}/access/policies

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Unique identifier for the account.
decision	string	Optional	The action Access will take if a user matches this policy. Infrastructure application policies can only use the Allow action.
include	array	Optional	Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
include.group	object	Optional	Parameter for Create an Access Reusable Policy
include.group.id	string	Optional	Unique identifier
name	string	Optional	The name of the Access policy.
approval_groups	array	Optional	Administrators who can approve a temporary authentication request.
approval_groups.approvals_needed	number	Optional	Parameter for Create an Access Reusable Policy
approval_groups.email_addresses	array	Optional	Parameter for Create an Access Reusable Policy
approval_groups.email_list_uuid	string	Optional	Unique identifier
approval_required	boolean	Optional	Requires the user to request access from an administrator at the start of each session.
purpose_justification_prompt	string	Optional	A custom message that will appear on the purpose justification screen.
purpose_justification_required	boolean	Optional	Require users to enter a justification when they log in to the application.
exclude	array	Optional	Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
exclude.group	object	Optional	Parameter for Create an Access Reusable Policy
exclude.group.id	string	Optional	Unique identifier
require	array	Optional	Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
require.group	object	Optional	Parameter for Create an Access Reusable Policy
require.group.id	string	Optional	Unique identifier
session_duration	string	Optional	The amount of time that tokens issued for the application will be valid.

Input Example

{"json_body":{"decision":"allow","include":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"name":"Allow devs","approval_groups":[{"approvals_needed":1,"email_addresses":["[email protected]","[email protected]"]},{"approvals_needed":3,"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34"}],"approval_required":true,"isolation_reqired":false,"purpose_justification_prompt":"Please enter a justification for entering this protected domain.","purpose_justification_required":true,"exclude":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"require":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"session_duration":"24h"},"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.app_count	number	Result of the operation
result.approval_groups	array	Result of the operation
result.approval_groups.approvals_needed	number	Result of the operation
result.approval_groups.email_addresses	array	Result of the operation
result.approval_groups.email_list_uuid	string	Unique identifier
result.approval_required	boolean	Result of the operation
result.decision	string	Result of the operation
result.exclude	array	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","app_count":2,"approval_groups":[],"approval_required":true,"decision":"allow","exclude":[],"include":[],"isolation_required":false,"name":"Allow devs","purpose_justification_prompt":"Please enter a justification for entering this protected domain.","purpose_justification_required":true,"require":[],"reusable":true,"session_duration":"24h"}}}

Create An Account Or Zone Ruleset

Create a Cloudflare ruleset for an account or zone using path parameters and JSON inputs like kind, name, and phase.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.account_ID_or_zone_ID	string	Required	The ID of the account or zone.
kind	string	Optional	The kind of the ruleset.
name	string	Optional	The human-readable name of the ruleset. Minimum length is 1 character.
phase	string	Optional	The phase of the ruleset.
description	string	Optional	An informative description of the ruleset.
rules	array	Optional	The list of rules in the ruleset.

Input Example

{"json_body":{"kind":"zone","name":"My ruleset","phase":"http_request_firewall_custom","description":"My ruleset to execute managed rulesets","rules":[]},"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Create An Account Or Zone Ruleset action
result.rules.action_parameters.response	object	Parameters for the Create An Account Or Zone Ruleset action
result.rules.action_parameters.response.content	string	Parameters for the Create An Account Or Zone Ruleset action
result.rules.action_parameters.response.content_type	string	Parameters for the Create An Account Or Zone Ruleset action
result.rules.action_parameters.response.status_code	number	Parameters for the Create An Account Or Zone Ruleset action
result.rules.description	string	Result of the operation

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{"kind":"root","name":"My ruleset","phase":"http_request_firewall_custom","rules":[],"description":"My ruleset to execute managed rulesets"},"success":true}}

Create An Account Or Zone Ruleset Rule

Add a new rule to a specified Cloudflare account or zone ruleset using 'accounts_or_zones', 'ruleset_id', and 'account_or_zone_id'.

Endpoint

URL: /{{accounts_or_zones}}/{{account_or_zone_id}}/rulesets/{{ruleset_id}}/rules

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Create An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response	object	Parameters for the Create An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.content	string	Parameters for the Create An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.content_type	string	Parameters for the Create An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.status_code	number	Parameters for the Create An Account Or Zone Ruleset Rule action
result.rules.description	string	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{"kind":"root","name":"My ruleset","phase":"http_request_firewall_custom","rules":[],"description":"My ruleset to execute managed rulesets"},"success":true}}

Create List Items

Append new items to a specified list in Cloudflare and initiate an asynchronous operation. Use the operation_id with the Get bulk operation status endpoint to track status.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}/items

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.

Input Example

{"json_body":{"ip":"10.0.0.1","comment":"Allow office IP"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{},"success":true}}

Create Zone

Initiate a new DNS zone creation in Cloudflare using user-provided account details and zone name.

Endpoint

URL: /zones

Method: POST

Input

Argument Name	Type	Required	Description
account	object	Optional	The account to which the zone belongs.
account.id	string	Optional	Unique identifier
name	string	Optional	The domain name.
type	string	Optional	A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.

Input Example

{"json_body":{"account":{"id":"1234567890abcdef1234567890abcdef"},"name":"example.com","type":"full"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.account	object	Result of the operation
result.account.id	string	Unique identifier
result.account.name	string	Name of the resource
result.meta	object	Result of the operation
result.meta.cdn_only	boolean	Result of the operation
result.meta.custom_certificate_quota	number	Result of the operation
result.meta.dns_only	boolean	Result of the operation
result.meta.foundation_dns	boolean	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"023e105f4ecef8ad9ca31a8372d0c353","account":{},"meta":{},"name":"example.com","owner":{},"plan":{},"cname_suffix":"cdn.cloudflare.com","paused":true,"permissions":[],"tenant":{},"tenant_unit":{},"type":"full","vanity_name_servers":[]}}}

Delete A List

Remove a specified list and all its items from Cloudflare using the account and list IDs.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.

Input Example

{"path_parameters":{"account_id":"string","list_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{},"success":true}}

Delete an Access Group

Remove a specified access group from an account or zone in Cloudflare using the provided account/zone and group IDs.

Endpoint

URL: /{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/access/groups/{{group_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.group_id	string	Required	The UUID of the Access group to delete.

Input Example

{"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"023e105f4ecef8ad9ca31a8372d0c353","group_id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{}}}

Delete An Access Reusable Policy

Remove a specified Access reusable policy from Cloudflare using the provided account and policy IDs.

Endpoint

URL: /accounts/{{account_id}}/access/policies/{{policy_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The unique identifier of the account.
path_parameters.policy_id	string	Required	The UUID of the policy.

Input Example

{"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353","policy_id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}}}

Delete An Account Or Zone Ruleset

Delete all versions of a specified account or zone ruleset in Cloudflare API using the provided ruleset ID, accounts or zones, and account ID or zone ID.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets/{{ruleset_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.account_ID_or_zone_ID	string	Required	The unique identifier for the account or zone.
path_parameters.ruleset_id	string	Required	The unique identifier for the ruleset.

Input Example

{"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34","ruleset_id":"8eb1584b2c3d40c69075c98b6a4d6ab7"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
response_text	string	Output field: response_text

Output Example

{"status_code":204,"response_headers":{"Date":"Wed, 11 Jun 2025 13:08:47 GMT","Connection":"keep-alive","CF-Ray":"94e156cc3f743fa8-BOM","CF-Cache-Status":"DYNAMIC","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzu97uRFe3pZjj; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","api-version":"2025-06-11","cf-auditlog-id":"01975f1b-7baf-7348-b77b-083ebae4ad6f","x-version":"11412-5d5ca7e64450","Server":"cloudflare"},"reason":"No Content","response_text":""}

Delete An Account Or Zone Ruleset Rule

Remove a specific rule from 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: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.
path_parameters.rule_id	string	Required	The unique ID of the rule to delete.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string","rule_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Delete An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response	object	Parameters for the Delete An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.content	string	Parameters for the Delete An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.content_type	string	Parameters for the Delete An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.status_code	number	Parameters for the Delete An Account Or Zone Ruleset Rule action
result.rules.description	string	Result of the operation

Output Example

Delete An Account Or Zone Ruleset Version

Delete a specific version of a Cloudflare account or zone ruleset using the required path parameters: accounts_or_zones, ruleset_id, account_or_zone_id, and ruleset_version.

Endpoint

URL: /{{accounts_or_zones}}/{{account_or_zone_id}}/rulesets/{{ruleset_id}}/versions/{{ruleset_version}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.
path_parameters.ruleset_version	string	Required	The version of the ruleset.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string","ruleset_version":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Delete An Account Or Zone Ruleset Version action
result.rules.action_parameters.response	object	Parameters for the Delete An Account Or Zone Ruleset Version action
result.rules.action_parameters.response.content	string	Parameters for the Delete An Account Or Zone Ruleset Version action
result.rules.action_parameters.response.content_type	string	Parameters for the Delete An Account Or Zone Ruleset Version action
result.rules.action_parameters.response.status_code	number	Parameters for the Delete An Account Or Zone Ruleset Version action
result.rules.description	string	Result of the operation

Output Example

Delete List Items

Remove specified items from a Cloudflare list asynchronously using account_id and list_id. Track the operation status with the Get bulk operation status endpoint.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}/items

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.
body	object	Required	Request Body
body.items	array	Optional	List of items to remove from the list.
body.items.id	string	Optional	Defines the unique ID of the item in the List.

Input Example

{"path_parameters":{"account_id":"string","list_id":"string"},"body":{"items":[{"id":"12345678-1234-1234-1234-123456789abc"}]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{},"success":true}}

Delete Zone

Remove a specified zone from Cloudflare's management using the unique 'zone_id'.

Endpoint

URL: /zones/{{zone_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone to be deleted.

Input Example

{"path_parameters":{"zone_id":"str023e105f4ecef8ad9ca31a8372d0c353ing"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"023e105f4ecef8ad9ca31a8372d0c353"}}}

Edit Zone

Modify a specific zone's configuration in Cloudflare using the provided zone_id.

Endpoint

URL: /zones/{{zone_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone to be edited.
paused	boolean	Optional	Indicates whether the zone is only using Cloudflare DNS services.
type	string	Optional	A full zone implies that DNS is hosted with Cloudflare.
vanity_name_servers	array	Optional	An array of domains used for custom name servers. This is only available for Business and Enterprise plans.

Input Example

{"json_body":{"paused":false,"type":"","vanity_name_servers":["example.com"]},"path_parameters":{"zone_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.account	object	Result of the operation
result.account.id	string	Unique identifier
result.account.name	string	Name of the resource
result.meta	object	Result of the operation
result.meta.cdn_only	boolean	Result of the operation
result.meta.custom_certificate_quota	number	Result of the operation
result.meta.dns_only	boolean	Result of the operation
result.meta.foundation_dns	boolean	Result of the operation

Output Example

Edit Zone Setting

Update a specific zone setting in Cloudflare using the provided zone_id and setting_id.

Endpoint

URL: client/v4/zones/{{zone_id}}/settings/{{setting_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone.
path_parameters.setting_id	string	Required	The unique identifier for the setting.
enabled	boolean	Optional	Parameter for Edit Zone Setting
value	object	Optional	Value for the parameter

Input Example

{"json_body":{"enabled":true,"value":{}},"path_parameters":{"zone_id":"test_zone_id","setting_id":"test_setting_id"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.value	string	Value for the parameter

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"0rtt","value":"on"}}}

Get A List

Retrieve details for a specified list using account and list IDs in Cloudflare API.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.

Input Example

{"path_parameters":{"account_id":"string","list_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.description	string	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{"kind":"ip","name":"list1","description":"This is a note"},"success":true}}

Get A List Item

Fetch a specific item from a list in Cloudflare using account ID, list ID, and item ID.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}/items/{{item_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.
path_parameters.item_id	string	Required	Defines the unique ID of the item in the List.

Input Example

{"path_parameters":{"account_id":"string","list_id":"string","item_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.ip	string	Result of the operation
result.comment	string	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{"ip":"10.0.0.1","comment":"Private IP address"},"success":true}}

Get An Access Group

Fetch A Specific Access Group From Cloudflare Using The Provided Account Or Zone ID And Group ID.

Endpoint

URL: /{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/access/groups/{{group_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.group_id	string	Required	The UUID of the Access group to delete.

Input Example

{"path_parameters":{"account_ID_or_zone_ID":"023e105f4ecef8ad9ca31a8372d0c353","accounts_or_zones":"zones","group_id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.exclude	array	Result of the operation
result.exclude.group	object	Result of the operation
result.exclude.group.id	string	Unique identifier
result.include	array	Result of the operation
result.include.group	object	Result of the operation
result.include.group.id	string	Unique identifier
result.is_default	array	Result of the operation
result.is_default.group	object	Result of the operation
result.is_default.group.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"exclude":[],"include":[],"is_default":[],"name":"Allow devs","require":[]}}}

Get An Access Reusable Policy

Retrieve a specific Cloudflare Access reusable policy using the provided account and policy IDs.

Endpoint

URL: /accounts/{{account_id}}/access/policies/{{policy_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Unique identifier for the account.
path_parameters.policy_id	string	Required	The UUID of the policy.

Input Example

{"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353","policy_id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.app_count	number	Result of the operation
result.approval_groups	array	Result of the operation
result.approval_groups.approvals_needed	number	Result of the operation
result.approval_groups.email_addresses	array	Result of the operation
result.approval_groups.email_list_uuid	string	Unique identifier
result.approval_required	boolean	Result of the operation
result.decision	string	Result of the operation
result.exclude	array	Result of the operation

Output Example

Get An Account Or Zone Entry Point Ruleset

Retrieve the latest version of an account or zone entry point ruleset in Cloudflare for a specified phase. Requires path parameters: accounts_or_zones, account_ID_or_zone_ID, and ruleset_phase.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets/phases/{{ruleset_phase}}/entrypoint

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.ruleset_phase	string	Required	The phase of the ruleset.

Input Example

{"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34","ruleset_phase":"http_request_firewall_custom"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Get An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response	object	Parameters for the Get An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response.content	string	Parameters for the Get An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response.content_type	string	Parameters for the Get An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response.status_code	number	Parameters for the Get An Account Or Zone Entry Point Ruleset action
result.rules.description	string	Result of the operation

Output Example

Get An Account Or Zone Entry Point Ruleset Version

Retrieve a specific version of an account or zone entry point ruleset in Cloudflare, detailing the phase and version. Requires path parameters: accounts_or_zones, account_ID_or_zone_ID, ruleset_phase, and ruleset_version.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets/phases/{{ruleset_phase}}/entrypoint/versions/{{ruleset_version}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.account_ID_or_zone_ID	string	Required	The unique identifier for the account or zone.
path_parameters.ruleset_phase	string	Required	The phase of the ruleset.
path_parameters.ruleset_version	string	Required	The version of the ruleset to fetch.

Input Example

{"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34","ruleset_phase":"http_request_firewall_custom","ruleset_version":"1"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.kind	string	Result of the operation
result.last_updated	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.source	string	Result of the operation
result.version	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
messages	array	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Wed, 11 Jun 2025 12:39:58 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"94e12c9bbb653fa8-BOM","CF-Cache-Status":"DYNAMIC","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuKpFhR7jpeiH; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","api-version":"2025-06-11","cf-auditlog-id":"01975f01-1d69-79c5-9f54-5247a71dbb7b","x-version":"11412-5d5ca...

Get An Account Or Zone Ruleset

Retrieve the latest version of a specified ruleset for an account or zone in Cloudflare using path parameters like accounts_or_zones, account_ID_or_zone_ID, and ruleset_id.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets/{{ruleset_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.account_ID_or_zone_ID	string	Required	The unique identifier for the account or zone.
path_parameters.ruleset_id	string	Required	The unique identifier for the ruleset.

Input Example

{"path_parameters":{"accounts_or_zones":"accounts","account_ID_or_zone_ID":"6560bc49a6a34abd353a8d4335702c23","ruleset_id":"77454fe2d30c4220b5701f6fdfb893ba"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	object	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.kind	string	Result of the operation
result.last_updated	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.action	string	Result of the operation
result.rules.categories	array	Result of the operation
result.rules.description	string	Result of the operation
result.rules.enabled	boolean	Result of the operation
result.rules.id	string	Unique identifier
result.rules.last_updated	string	Result of the operation
result.rules.ref	string	Result of the operation
result.rules.version	string	Result of the operation
result.source	string	Result of the operation
result.version	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
messages	array	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Wed, 11 Jun 2025 13:02:10 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"94e14d1bec523fa8-BOM","CF-Cache-Status":"DYNAMIC","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuUMPyvzJEptd; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","api-version":"2025-06-11","cf-auditlog-id":"01975f15-6d80-7261-a0df-2c55a38d39e5","x-version":"11412-5d5ca...

Get An Account Or Zone Ruleset Version

Retrieve a specific version of a Cloudflare account or zone ruleset using the provided ruleset ID and version number. Requires path parameters: accounts_or_zones, ruleset_id, account_or_zone_id, and ruleset_version.

Endpoint

URL: /{{accounts_or_zones}}/{{account_or_zone_id}}/rulesets/{{ruleset_id}}/versions/{{ruleset_version}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.
path_parameters.ruleset_version	string	Required	The version of the ruleset.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string","ruleset_version":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Get An Account Or Zone Ruleset Version action
result.rules.action_parameters.response	object	Parameters for the Get An Account Or Zone Ruleset Version action
result.rules.action_parameters.response.content	string	Parameters for the Get An Account Or Zone Ruleset Version action
result.rules.action_parameters.response.content_type	string	Parameters for the Get An Account Or Zone Ruleset Version action
result.rules.action_parameters.response.status_code	number	Parameters for the Get An Account Or Zone Ruleset Version action
result.rules.description	string	Result of the operation

Output Example

Get Bulk Operation Status

Retrieve the status of an asynchronous bulk operation in Cloudflare using account and operation IDs.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/bulk_operations/{{operation_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.operation_id	string	Required	The unique operation ID of the asynchronous action.

Input Example

{"path_parameters":{"account_id":"string","operation_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{},"success":true}}

Get IP Lists

Retrieve a list of IP addresses associated with the specified account_id from Cloudflare.

Endpoint

URL: /accounts/{{account_id}}/intel/ip-list

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	Identifier.

Input Example

{"path_parameters":{"account_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	array	Result of the operation
result.id	number	Unique identifier
result.description	string	Result of the operation
result.name	string	Name of the resource
success	boolean	Whether the operation was successful
result_info	object	Result of the operation
result_info.count	number	Result of the operation
result_info.page	number	Result of the operation
result_info.per_page	number	Result of the operation
result_info.total_count	number	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":[{}],"success":true,"result_info":{"count":1,"page":1,"per_page":20,"total_count":2000}}}

Get List Items

Retrieve all items from a specified list within Cloudflare using the account and list IDs.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}/items

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.
query_parameters.cursor	string	Optional	The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records.
query_parameters.per_page	number	Optional	Amount of results to include in each paginated response. A non-negative 32 bit integer.
query_parameters.search	string	Optional	A search query to filter returned items. Its meaning depends on the list type.

Input Example

{"path_parameters":{"account_id":"string","list_id":"string"},"query_parameters":{"cursor":"string","per_page":123,"search":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	array	Result of the operation
result.ip	string	Result of the operation
result.comment	string	Result of the operation
success	boolean	Whether the operation was successful
result_info	object	Result of the operation
result_info.cursors	object	Result of the operation
result_info.cursors.after	string	Result of the operation
result_info.cursors.before	string	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":[{}],"success":true,"result_info":{"cursors":{}}}}

Get Lists

Retrieve all lists associated with a specified account ID in Cloudflare.

Endpoint

URL: /accounts/{{account_id}}/rules/lists

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.

Input Example

{"path_parameters":{"account_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	array	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.description	string	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":[{}],"success":true}}

Get Zone Setting

Retrieve a specific zone setting from Cloudflare API using the provided zone and setting IDs.

Endpoint

URL: client/v4/zones/{{zone_id}}/settings/{{setting_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone.
path_parameters.setting_id	string	Required	The unique identifier for the setting.

Input Example

{"path_parameters":{"zone_id":"test_zone_id","setting_id":"test_setting_id"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.value	string	Value for the parameter

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"0rtt","value":"on"}}}

List Access Groups

Retrieve all access groups for a specified Cloudflare account or zone using the provided account ID or zone ID.

Endpoint

URL: /{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/access/groups

Method: GET

Input

Argument Name	Type	Required	Description
parameters.name	string	Optional	The name of the group.
parameters.page	number	Optional	Page number of results.
parameters.per_page	number	Optional	Number of results per page.
parameters.search	string	Optional	Search for groups by other listed query parameters.
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.accounts_or_zones	string	Required	The type of account or zone.

Input Example

{"parameters":{"name":"Get an Access Reusable Policy","page":0,"per_page":20,"search":"test"},"path_parameters":{"account_ID_or_zone_ID":"023e105f4ecef8ad9ca31a8372d0c353","accounts_or_zones":"zones"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	array	Result of the operation
result.exclude	array	Result of the operation
result.exclude.group	object	Result of the operation
result.exclude.group.id	string	Unique identifier
result.include	array	Result of the operation
result.include.group	object	Result of the operation
result.include.group.id	string	Unique identifier
result.is_default	array	Result of the operation
result.is_default.group	object	Result of the operation
result.is_default.group.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":[{}],"result_info":{"count":1,"page":1,"per_page":20,"total_count":2000}}}

List Access Reusable Policies

Retrieve a list of reusable access policies for an account in Cloudflare API using the 'account_id' parameter.

Endpoint

URL: /accounts/{{account_id}}/access/policies

Method: GET

Input

Argument Name	Type	Required	Description
parameters.page	number	Optional	Page number of results.
parameters.per_page	number	Optional	Number of results per page.
path_parameters.account_id	string	Required	The unique identifier for the account.

Input Example

{"parameters":{"page":1,"per_page":20},"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	array	Result of the operation
result.id	string	Unique identifier
result.app_count	number	Result of the operation
result.approval_groups	array	Result of the operation
result.approval_groups.approvals_needed	number	Result of the operation
result.approval_groups.email_addresses	array	Result of the operation
result.approval_groups.email_list_uuid	string	Unique identifier
result.approval_required	boolean	Result of the operation
result.decision	string	Result of the operation
result.exclude	array	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":[{}],"result_info":{"count":1,"page":1,"per_page":20,"total_count":2000}}}

List Account Or Zone Entry Point Ruleset Versions

Fetch versions of a Cloudflare account or zone entry point ruleset using specific path parameters like accounts_or_zones, account_ID_or_zone_ID, and ruleset_phase.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets/phases/{{ruleset_phase}}/entrypoint/versions

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.ruleset_phase	string	Required	The phase of the ruleset.

Input Example

{"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34","ruleset_phase":"http_request_firewall_custom"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	array	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.kind	string	Result of the operation
result.last_updated	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.source	string	Result of the operation
result.version	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
messages	array	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Wed, 11 Jun 2025 11:55:40 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"94e0ebb4393c3fa8-BOM","CF-Cache-Status":"DYNAMIC","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuQeo3jFQn3FT; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","api-version":"2025-06-11","cf-auditlog-id":"01975ed8-8cb9-75a5-abf5-42f67908d093","x-version":"11412-5d5ca...

List Account Or Zone Rulesets

Retrieve all rulesets for a specified Cloudflare account or zone using the account or zone ID as a path parameter.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets

Method: GET

Input

Argument Name	Type	Required	Description
parameters.cursor	string	Optional	Cursor to use for the next page. minimum length is 1 character.
parameters.per_page	number	Optional	The number of results to return per page. minimum value is 1, maximum value is 50.
path_parameters.accounts_or_zones	string	Required	The type of resource to query, either 'accounts' or 'zones'.
path_parameters.account_ID_or_zone_ID	string	Required	The ID of the account or zone to query.

Input Example

{"parameters":{"cursor":"dGhpc2lzYW5leGFtcGxlCg","per_page":20},"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
result	array	Result of the operation
result.description	string	Result of the operation
result.id	string	Unique identifier
result.kind	string	Result of the operation
result.last_updated	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.version	string	Result of the operation
result.source	string	Result of the operation
success	boolean	Whether the operation was successful
errors	array	Error message if any
messages	array	Response message

Output Example

{"status_code":200,"response_headers":{"Date":"Wed, 11 Jun 2025 10:42:22 GMT","Content-Type":"application/json; charset=UTF-8","Transfer-Encoding":"chunked","Connection":"keep-alive","CF-Ray":"94e0805229b83fa8-BOM","CF-Cache-Status":"DYNAMIC","Content-Encoding":"gzip","Set-Cookie":"__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuGwFNkXRzujB; SameSite=Lax; path=/; expire...","Vary":"Accept-Encoding","api-version":"2025-06-11","cf-auditlog-id":"01975e95-6f6a-7cfa-906f-cbfb83dd52de","x-version":"11412-5d5ca...

List An Account Or Zone Ruleset's Versions

Fetch The Versions Of A Specified Cloudflare Account Or Zone Ruleset Using The Ruleset ID And Account/Zone ID.

Endpoint

URL: /{{accounts_or_zones}}/{{account_or_zone_id}}/rulesets/{{ruleset_id}}/versions

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	array	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.description	string	Result of the operation
success	boolean	Whether the operation was successful
result_info	object	Result of the operation
result_info.cursors	object	Result of the operation
result_info.cursors.after	string	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":[{}],"success":true,"result_info":{"cursors":{}}}}

List Zones

Retrieve, search, sort, and filter a list of zones from the Cloudflare account.

Endpoint

URL: /zones

Method: GET

Input

Argument Name	Type	Required	Description
parameters.account	object	Optional	The account to list zones for.
parameters.account.id	string	Optional	Parameters for the List Zones action
parameters.account.name	string	Optional	Parameters for the List Zones action
parameters.direction	string	Optional	Direction to order zones.
parameters.match	string	Optional	Whether to match all search requirements or at least one (any).
parameters.name	string	Optional	A domain name.
parameters.order	string	Optional	Field to order zones by.
parameters.page	number	Optional	Page number of paginated results.
parameters.per_page	number	Optional	Number of zones per page.
parameters.status	string	Optional	Specify a zone status to filter by.

Input Example

{"parameters":{"account":{"id":"list_zones","name":"List Zones"},"direction":"asc","match":"any","name":"example.com","order":"name","page":1,"per_page":20,"status":"pending"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	array	Result of the operation
result.id	string	Unique identifier
result.account	object	Result of the operation
result.account.id	string	Unique identifier
result.account.name	string	Name of the resource
result.meta	object	Result of the operation
result.meta.cdn_only	boolean	Result of the operation
result.meta.custom_certificate_quota	number	Result of the operation
result.meta.dns_only	boolean	Result of the operation
result.meta.foundation_dns	boolean	Result of the operation

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":[{}],"result_info":{"count":1,"page":1,"per_page":20,"total_count":2000,"total_pages":100}}}

Purge Cached Content

Clear all files from Cloudflare's cache for a specified zone using the provided zone_id.

Endpoint

URL: /zones/{{zone_id}}/purge_cache

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone to purge cached content.
tags	array	Optional	Purge with tags.
hosts	array	Optional	Purge with hosts.
prefixes	array	Optional	Purge with prefixes.
files	array	Optional	Purge with either list of files or with list of url and header pairs.
purge_everything	boolean	Optional	Purge all cached content in the zone.

Input Example

{"json_body":{"tags":["a-cache-tag"],"hosts":["example.com"],"prefixes":["www.example.com/foo"],"files":["http://www.example.com/css/styles.css"],"purge_everything":true},"path_parameters":{"zone_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"023e105f4ecef8ad9ca31a8372d0c353"}}}

Rerun the Activation Check

Initiate a new activation check for a Cloudflare Zone in PENDING status using the provided 'zone_id'.

Endpoint

URL: /zones/{{zone_id}}/activation_check

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone to be checked.

Input Example

{"path_parameters":{"zone_id":"str023e105f4ecef8ad9ca31a8372d0c353ing"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"id":"023e105f4ecef8ad9ca31a8372d0c353"}}}

Update A List

Update a specified list's description in Cloudflare using account and list IDs. Requires path parameters and body content.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.
body	object	Required	Request Body
body.description	string	Optional	An informative summary of the list.

Input Example

{"path_parameters":{"account_id":"string","list_id":"string"},"body":{"description":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.description	string	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{"kind":"ip","name":"list1","description":"This is a note"},"success":true}}

Update All List Items

Remove and add items to a specified list in Cloudflare asynchronously. Requires account_id and list_id as path parameters. Use operation_id with the Get bulk operation status endpoint for updates.

Endpoint

URL: /accounts/{{account_id}}/rules/lists/{{list_id}}/items

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The Account ID for this resource.
path_parameters.list_id	string	Required	The unique ID of the list.

Input Example

{"json_body":{"ip":"10.0.0.1","comment":"Allow office IP"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
success	boolean	Whether the operation was successful

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"result":{},"success":true}}

Update an Access group.

Update an existing Cloudflare Access group using account/zone ID and group ID, with options to include name and rules.

Endpoint

URL: /{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/access/groups/{{group_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.account_ID_or_zone_ID	string	Required	Identifier for the Account or Zone.
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.group_id	string	Required	The UUID of the Access group to delete.
include	array	Optional	Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
include.group	object	Optional	Parameter for Update an Access group.
include.group.id	string	Optional	Unique identifier
exclude	array	Optional	Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
exclude.group	object	Optional	Parameter for Update an Access group.
exclude.group.id	string	Optional	Unique identifier
name	string	Optional	The name of the Access group.
is_default	boolean	Optional	Whether this is the default group.
require	array	Optional	Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
require.group	object	Optional	Parameter for Update an Access group.
require.group.id	string	Optional	Unique identifier

Input Example

{"json_body":{"include":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"exclude":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"name":"Allow devs","is_default":false,"require":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}]},"path_parameters":{"account_ID_or_zone_ID":"023e105f4ecef8ad9ca31a8372d0c353","accounts_or_zones":"zones","group_id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.exclude	array	Result of the operation
result.exclude.group	object	Result of the operation
result.exclude.group.id	string	Unique identifier
result.include	array	Result of the operation
result.include.group	object	Result of the operation
result.include.group.id	string	Unique identifier
result.is_default	array	Result of the operation
result.is_default.group	object	Result of the operation
result.is_default.group.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","json_body":{"errors":[{}],"messages":[{}],"success":true,"result":{"exclude":[],"include":[],"is_default":[],"name":"Allow devs","require":[]}}}

Update An Access Reusable Policy

Update an existing Cloudflare Access reusable policy using account_id, policy_id, and parameters such as decision, include, and name.

Endpoint

URL: /accounts/{{account_id}}/access/policies/{{policy_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.account_id	string	Required	The account identifier.
path_parameters.policy_id	string	Required	The UUID of the policy.
decision	string	Optional	The action Access will take if a user matches this policy.
include	array	Optional	Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules..
include.group	object	Optional	Parameter for Update An Access Reusable Policy
include.group.id	string	Optional	Unique identifier
name	string	Optional	The name of the Access policy.
approval_groups	array	Optional	Administrators who can approve a temporary authentication request.
approval_groups.approvals_needed	number	Optional	Parameter for Update An Access Reusable Policy
approval_groups.email_addresses	array	Optional	Parameter for Update An Access Reusable Policy
approval_groups.email_list_uuid	string	Optional	Unique identifier
approval_required	boolean	Optional	Requires the user to request access from an administrator at the start of each session.
exclude	array	Optional	Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
exclude.group	object	Optional	Parameter for Update An Access Reusable Policy
exclude.group.id	string	Optional	Unique identifier
isolation_required	boolean	Optional	Require this application to be served in an isolated browser for users matching this policy.
purpose_justification_prompt	string	Optional	A custom message that will appear on the purpose justification screen.
purpose_justification_required	boolean	Optional	Require users to enter a justification when they log in to the application.
require	array	Optional	Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
require.group	object	Optional	Parameter for Update An Access Reusable Policy
require.group.id	string	Optional	Unique identifier
session_duration	string	Optional	The amount of time that tokens issued for the application will be valid.

Input Example

{"json_body":{"decision":"allow","include":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"name":"Allow devs","approval_groups":[{"approvals_needed":1,"email_addresses":["[email protected]","[email protected]"]},{"approvals_needed":3,"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34"}],"approval_required":true,"exclude":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"isolation_required":false,"purpose_justification_prompt":"Please enter a justification for entering this protected domain.","purpose_justification_required":true,"require":[{"group":{"id":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f"}}],"session_duration":"24h"},"path_parameters":{"account_id":"023e105f4ecef8ad9ca31a8372d0c353","policy_id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.app_count	number	Result of the operation
result.approval_groups	array	Result of the operation
result.approval_groups.approvals_needed	number	Result of the operation
result.approval_groups.email_addresses	array	Result of the operation
result.approval_groups.email_list_uuid	string	Unique identifier
result.approval_required	boolean	Result of the operation
result.decision	string	Result of the operation
result.exclude	array	Result of the operation

Output Example

Update An Account Or Zone Entry Point Ruleset

Update a Cloudflare account or zone entry point ruleset using specified path parameters and JSON body.

Endpoint

URL: client/v4/{{accounts_or_zones}}/{{account_ID_or_zone_ID}}/rulesets/phases/{{ruleset_phase}}/entrypoint

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of resource to target, either 'accounts' or 'zones'.
path_parameters.account_ID_or_zone_ID	string	Required	The unique identifier for the account or zone.
path_parameters.ruleset_phase	string	Required	The phase of the ruleset to update.
description	string	Optional	An informative description of the ruleset.
name	string	Optional	The human-readable name of the ruleset.
rules	array	Optional	A list of rules to be included in the ruleset.

Input Example

{"json_body":{"description":"My ruleset to execute managed rulesets","name":"My ruleset","rules":[]},"path_parameters":{"accounts_or_zones":"zones","account_ID_or_zone_ID":"b8a144539f69c46084f32c6818d79f34","ruleset_phase":"http_request_firewall_custom"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Update An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response	object	Parameters for the Update An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response.content	string	Parameters for the Update An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response.content_type	string	Parameters for the Update An Account Or Zone Entry Point Ruleset action
result.rules.action_parameters.response.status_code	number	Parameters for the Update An Account Or Zone Entry Point Ruleset action
result.rules.description	string	Result of the operation

Output Example

Update An Account Or Zone Ruleset

Update a specified Cloudflare account or zone ruleset using 'ruleset_id' and 'account_or_zone_id'.

Endpoint

URL: /{{accounts_or_zones}}/{{account_or_zone_id}}/rulesets/{{ruleset_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Update An Account Or Zone Ruleset action
result.rules.action_parameters.response	object	Parameters for the Update An Account Or Zone Ruleset action
result.rules.action_parameters.response.content	string	Parameters for the Update An Account Or Zone Ruleset action
result.rules.action_parameters.response.content_type	string	Parameters for the Update An Account Or Zone Ruleset action
result.rules.action_parameters.response.status_code	number	Parameters for the Update An Account Or Zone Ruleset action
result.rules.description	string	Result of the operation

Output Example

Update An Account Or Zone Ruleset Rule

Update a specific rule within a Cloudflare account or zone ruleset using the provided accounts_or_zones, ruleset_id, account_or_zone_id, and rule_id.

Endpoint

URL: /{{accounts_or_zones}}/{{account_or_zone_id}}/rulesets/{{ruleset_id}}/rules/{{rule_id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.accounts_or_zones	string	Required	The type of account or zone.
path_parameters.ruleset_id	string	Required	The unique ID of the ruleset.
path_parameters.account_or_zone_id	string	Required	The Account or Zone ID to use for this endpoint.
path_parameters.rule_id	string	Required	The unique ID of the rule to update.

Input Example

{"path_parameters":{"accounts_or_zones":"string","ruleset_id":"string","account_or_zone_id":"string","rule_id":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.message	string	Response message
errors.code	number	Error message if any
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.message	string	Response message
messages.code	number	Response message
messages.source	object	Response message
messages.source.pointer	string	Response message
result	object	Result of the operation
result.kind	string	Result of the operation
result.name	string	Name of the resource
result.phase	string	Result of the operation
result.rules	array	Result of the operation
result.rules.id	string	Unique identifier
result.rules.action	string	Result of the operation
result.rules.action_parameters	object	Parameters for the Update An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response	object	Parameters for the Update An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.content	string	Parameters for the Update An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.content_type	string	Parameters for the Update An Account Or Zone Ruleset Rule action
result.rules.action_parameters.response.status_code	number	Parameters for the Update An Account Or Zone Ruleset Rule action
result.rules.description	string	Result of the operation

Output Example

Zone Details

Retrieve detailed information for a specific zone in Cloudflare using the provided zone_id.

Endpoint

URL: /zones/{{zone_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.zone_id	string	Required	The unique identifier for the zone.

Input Example

{"path_parameters":{"zone_id":"023e105f4ecef8ad9ca31a8372d0c353"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
errors	array	Error message if any
errors.code	number	Error message if any
errors.message	string	Response message
errors.documentation_url	string	URL endpoint for the request
errors.source	object	Error message if any
errors.source.pointer	string	Error message if any
messages	array	Response message
messages.code	number	Response message
messages.message	string	Response message
messages.documentation_url	string	URL endpoint for the request
messages.source	object	Response message
messages.source.pointer	string	Response message
success	boolean	Whether the operation was successful
result	object	Result of the operation
result.id	string	Unique identifier
result.account	object	Result of the operation
result.account.id	string	Unique identifier
result.account.name	string	Name of the resource
result.meta	object	Result of the operation
result.meta.cdn_only	boolean	Result of the operation
result.meta.custom_certificate_quota	number	Result of the operation
result.meta.dns_only	boolean	Result of the operation
result.meta.foundation_dns	boolean	Result of the operation

Output Example

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	01921da7-1c87-743f-a112-9d4abc959c99
CF-Cache-Status	HTTP response header: CF-Cache-Status	DYNAMIC
CF-Ray	HTTP response header: CF-Ray	94e14d1bec523fa8-BOM
Connection	HTTP response header: Connection	keep-alive
Content-Encoding	HTTP response header: Content-Encoding	gzip
Content-Type	The media type of the resource	application/json; charset=UTF-8
Date	The date and time at which the message was originated	Mon, 23 Sep 2024 07:29:27 GMT
Server	Information about the software used by the origin server	cloudflare
Set-Cookie	HTTP response header: Set-Cookie	__cflb=0H28vgHxwvgAQtjUGU4yFBDJQfw1pfzuQeo3jFQn3FT; SameSite=Lax; path=/; expires=Wed, 11-Jun-25 14:25:41 GMT; HttpOnly, __cf_bm=s5olNgZm7eMyvtKZaj_JAvH0nWod6ZAOS49D_11kDGM-1749642940-1.0.1.1-3oKaTrI.krkQH1jIAXEVHtWXnvFoFllnPUJdCc8PYNjs_otbX0j41pfkGnXlGg1IxsANjtO02o6bPdge60zY1_NRchlIkIWqJ0j1su3col0; path=/; expires=Wed, 11-Jun-25 12:25:40 GMT; domain=.api.cloudflare.com; HttpOnly; Secure; SameSite=None, _cfuvid=dV2cFZI7LVGxnYhz1PSXA3KI_SIhMHyuP1_rn.YrbgY-1749642940405-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