Cloudflare api key | Composio Docs

Overview

SLUG: CLOUDFLARE_API_KEY

Description

Cloudflare provides a suite of services to enhance the security, performance, and reliability of websites and applications.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Cloudflare api key

Create an auth config

Use the dashboard to create an auth config for the Cloudflare api key toolkit. This allows you to connect multiple Cloudflare api key accounts to Composio for agents to use.

Select App

Navigate to [Cloudflare api key](https://platform.composio.dev?next_page=/marketplace/Cloudflare api key).

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Cloudflare api key Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 cloudflare_api_key_auth_config_id = "ac_YOUR_CLOUDFLARE_API_KEY_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Cloudflare api key for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, cloudflare_api_key_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Cloudflare api key toolkit’s playground](https://app.composio.dev/app/Cloudflare api key)

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["CLOUDFLARE_API_KEY"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

CLOUDFLARE_API_KEY_CREATE_DNS_RECORD

Tool Name: Create DNS Record

Description

Tool to create a new DNS record in a Cloudflare zone. Use when you need to add a record (A, CNAME, TXT, MX, etc.) to a specified zone.

Action Parameters

comment

string

content

string

name

stringRequired

proxied

boolean

settings

object

CLOUDFLARE_API_KEY_CREATE_LOCKDOWN_RULE

Tool Name: Create Zone Lockdown Rule

Description

Tool to create a Zone Lockdown rule. Use when you need to restrict access to specific URL patterns to defined IPs/CIDR ranges. Use after confirming zone_id.

Action Parameters

configurations

arrayRequired

description

string

paused

boolean

priority

integer

urls

arrayRequired

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_CREATE_RULE_IN_RULESET

Tool Name: Create Rule in Ruleset

Description

Tool to add a rule to an existing ruleset. Use when you need to append or insert a new rule in a Cloudflare ruleset.

Action Parameters

account_id

string

accounts_or_zones

stringRequired

rule

objectRequired

ruleset_id

stringRequired

zone_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_CREATE_RULESET

Tool Name: Create Ruleset

Description

Tool to create an account- or zone-scoped ruleset. Use after defining your ruleset details and selecting the correct scope.

Action Parameters

account_or_zone_id

stringRequired

accounts_or_zones

stringRequired

description

string

kind

stringRequired

name

stringRequired

phase

stringRequired

rules

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_DELETE_DNS_RECORD

Tool Name: Delete DNS Record

Description

Tool to delete a DNS record. Use when you need to remove a specific DNS record from a zone after confirming both zone and record IDs.

Action Parameters

dns_record_id

stringRequired

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_DELETE_DNSSEC

Tool Name: Delete DNSSEC

Description

Tool to delete DNSSEC records for a zone. Use after disabling DNSSEC at the registrar to remove DNSSEC configuration.

Action Parameters

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_DELETE_RULE_FROM_RULESET

Tool Name: Delete Rule from Ruleset

Description

Tool to delete a specific rule from a ruleset. Use when you need to remove an outdated or incorrect rule from an account or zone ruleset after confirming IDs.

Action Parameters

account_or_zone_id

stringRequired

accounts_or_zones

stringRequired

rule_id

stringRequired

ruleset_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_DELETE_RULESET

Tool Name: Delete Ruleset

Description

Tool to delete all versions of a ruleset. Use when you need to remove a ruleset from an account or zone after confirming no references exist.

Action Parameters

account_or_zone_id

stringRequired

accounts_or_zones

stringRequired

ruleset_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_DELETE_ZONE

Tool Name: Delete a zone

Description

Tool to delete an existing zone. Use after confirming the zone_id to permanently remove the zone.

Action Parameters

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_GET_ENTRYPOINT_RULESET_VERSION

Tool Name: Get Entrypoint Ruleset Version

Description

Tool to get a specific version of an entry point ruleset. Use after determining the ruleset phase and version.

Action Parameters

account_or_zone_id

stringRequired

accounts_or_zones

stringRequired

ruleset_phase

stringRequired

ruleset_version

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_GET_LOCKDOWN_RULE

Tool Name: Get Lockdown Rule

Description

Tool to get a Zone Lockdown rule. Use when you need to fetch details of a specific lockdown rule by its ID within a Cloudflare zone.

Action Parameters

lockdown_id

stringRequired

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_GET_REGIONAL_TIERED_CACHE

Tool Name: Get Regional Tiered Cache

Description

Tool to get the regional tiered cache setting for a zone. Use when you need to verify if regional tiered cache is enabled for performance optimization after zone activation.

Action Parameters

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_GET_RULESET

Tool Name: Get Ruleset

Description

Tool to fetch the latest version of a ruleset by ID. Use after you have the ruleset scope and ID.

Action Parameters

account_id

string

accounts_or_zones

stringRequired

ruleset_id

stringRequired

zone_id

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_GET_ZONE_DETAILS

Tool Name: Get Zone Details

Description

Tool to get details for a specific zone. Use when you need detailed zone metadata by ID.

Action Parameters

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_LIST_DNS_RECORDS

Tool Name: List DNS Records

Description

Tool to list DNS records for a given Cloudflare zone.

Action Parameters

content

string

direction

string

match

stringDefaults to all

name

string

order

string

page

integerDefaults to 1

per_page

integerDefaults to 20

type

string

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_LIST_ZONES

Tool Name: List Cloudflare Zones

Description

Tool to list, search, sort, and filter Cloudflare zones. Use when you need to retrieve a paginated list of zones available to the authenticated user.

Action Parameters

account.id

string

account.name

string

direction

string

match

stringDefaults to all

name

string

order

string

page

integerDefaults to 1

per_page

integerDefaults to 20

status

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_OVERWRITE_DNS_RECORD

Tool Name: Overwrite DNS Record

Description

Tool to completely overwrite a DNS record. Use when you need to replace all record details after confirming record type and name.

Action Parameters

comment

string

content

string

dns_record_id

stringRequired

name

stringRequired

proxied

boolean

settings

object

CLOUDFLARE_API_KEY_RERUN_ZONE_ACTIVATION_CHECK

Tool Name: Rerun Zone Activation Check

Description

Tool to trigger a new activation check for a PENDING zone. Use after initial zone creation to revalidate DNS activation. Limited rate: every 5 minutes on paygo/Enterprise or hourly on Free.

Action Parameters

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_UPDATE_DNSSEC_STATUS

Tool Name: Update DNSSEC Status

Description

Tool to update DNSSEC configuration for a zone. Use when you need to enable or disable DNSSEC or adjust DNSSEC options after confirming the zone ID.

Action Parameters

dnssec_multi_signer

boolean

dnssec_presigned

boolean

dnssec_use_nsec3

boolean

status

string

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_UPDATE_LOCKDOWN_RULE

Tool Name: Update Lockdown Rule

Description

Tool to update a zone lockdown rule. Use when you need to modify the IP or URL settings of an existing Zone Lockdown rule after confirming the rule exists.

Action Parameters

configurations

arrayRequired

lock_downs_id

stringRequired

urls

arrayRequired

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_UPDATE_RULE_IN_RULESET

Tool Name: Update Rule in Ruleset

Description

Tool to update a specific rule in a ruleset. Use when you need to modify a rule's configuration or reorder it after reviewing its current settings.

Action Parameters

account_or_zone_id

stringRequired

accounts_or_zones

stringRequired

position

object

rule

object

rule_id

stringRequired

ruleset_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_UPDATE_RULESET

Tool Name: Update Ruleset

Description

Tool to update a Cloudflare ruleset, creating a new version. Use when you need to modify ruleset description or rules list.

Action Parameters

account_or_zone_id

stringRequired

accounts_or_zones

stringRequired

description

string

kind

string

name

string

phase

string

rules

array

ruleset_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_UPDATE_ZONE

Tool Name: Update Cloudflare Zone

Description

Tool to edit a Cloudflare zone. Use when you need to update a single zone property at a time. Ensure only one of paused, type, or vanity_name_servers is provided per call.

Action Parameters

paused

boolean

type

string

vanity_name_servers

array

zone_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

CLOUDFLARE_API_KEY_UPLOAD_FILE_TO_S3

Tool Name: Upload File to S3

Description

Tool to upload arbitrary file content to the app’s temporary R2/S3 bucket. Use when you need to stage files for actions requiring FileUploadable.

Action Parameters

content

stringRequired

file_name

stringRequired

mimetype

stringDefaults to text/plain

Action Response

data

objectRequired

error

string

successful

booleanRequired