Cloudflare Api Key

cloudflare_api_key

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

Security & Identity Tools Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (24)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create DNS RecordCLOUDFLARE_API_KEY_CREATE_DNS_RECORDAcción

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.

Parámetros de entrada

ttlinteger
Time to live for DNS record in seconds; 1 means automatic (Cloudflare default).
namestringObligatorio
Fully qualified DNS record name in Punycode.
tagsstring[]
Custom tags in the form "name:value".
typestringObligatorioenum
DNS record type.
AAAAACNAMEMXTXTSRVLOCSPFCERTDNSKEYDSNAPTR+5
commentstring
Free-form comment for the DNS record.
contentstring
Record content; for types like A/AAAA use IP address, for CNAME use target hostname, etc.
proxiedboolean
Whether the record is receiving the performance and security benefits of Cloudflare.
zone_idstringObligatorio
Zone identifier in which to create the DNS record.
settingsobject
Settings specific to A record when proxied.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Zone Lockdown RuleCLOUDFLARE_API_KEY_CREATE_LOCKDOWN_RULEAcción

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.

Parámetros de entrada

urlsstring[]Obligatorio
URLs to lock down; supports simple wildcard '*' patterns.
pausedboolean
Whether to start the rule in a paused state.
zone_idstringObligatorio
Zone identifier.
priorityinteger
Processing priority (lower numbers run first).
descriptionstring
Optional summary of the rule.
configurationsobject[]Obligatorio
One or more sources to allow (IP or CIDR ranges).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Rule in RulesetCLOUDFLARE_API_KEY_CREATE_RULE_IN_RULESETAcción

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

Parámetros de entrada

ruleobjectObligatorio
Definition of the rule to add
zone_idstring
Zone identifier; required if using zones segment
account_idstring
Account identifier; required if using accounts segment
ruleset_idstringObligatorio
ID of the target ruleset
accounts_or_zonesstringObligatorioenum
Segment for owner: 'accounts' or 'zones'
accountszones

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create RulesetCLOUDFLARE_API_KEY_CREATE_RULESETAcción

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

Parámetros de entrada

kindstringObligatorioenum
Type of ruleset. Allowed values: custom, root, zone
customrootzone
namestringObligatorio
Human-readable name for the ruleset
phasestringObligatorio
Execution phase for the ruleset (e.g., http_request_firewall_custom, http_config_settings, ddos_l7, http_response_headers_transform, etc.)
rulesobject[]
Optional list of rules to include in the ruleset
descriptionstring
Optional description for the ruleset
accounts_or_zonesstringObligatorioenum
Scope for the ruleset: 'accounts' or 'zones'
accountszones
account_or_zone_idstringObligatorio
Identifier of the account or zone where the ruleset will be created

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DNS RecordCLOUDFLARE_API_KEY_DELETE_DNS_RECORDAcción

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.

Parámetros de entrada

zone_idstringObligatorio
Zone identifier (max length 32).
dns_record_idstringObligatorio
DNS record identifier (max length 32).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete DNSSECCLOUDFLARE_API_KEY_DELETE_DNSSECAcción

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

Parámetros de entrada

zone_idstringObligatorio
Zone identifier to delete DNSSEC for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Rule from RulesetCLOUDFLARE_API_KEY_DELETE_RULE_FROM_RULESETAcción

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.

Parámetros de entrada

rule_idstringObligatorio
Unique identifier of the rule to delete
ruleset_idstringObligatorio
Unique identifier of the ruleset
accounts_or_zonesstringObligatorioenum
Scope for the ruleset: 'accounts' or 'zones'
accountszones
account_or_zone_idstringObligatorio
Identifier of the account or zone owning the ruleset

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete RulesetCLOUDFLARE_API_KEY_DELETE_RULESETAcción

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.

Parámetros de entrada

ruleset_idstringObligatorio
Unique identifier of the ruleset to delete.
accounts_or_zonesstringObligatorioenum
Scope of the ruleset. Must be 'accounts' or 'zones'.
accountszones
account_or_zone_idstringObligatorio
Account ID if scope is 'accounts', or Zone ID if scope is 'zones'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a zoneCLOUDFLARE_API_KEY_DELETE_ZONEAcción

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

Parámetros de entrada

zone_idstringObligatorio
Zone identifier to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Entrypoint Ruleset VersionCLOUDFLARE_API_KEY_GET_ENTRYPOINT_RULESET_VERSIONAcción

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

Parámetros de entrada

ruleset_phasestringObligatorio
Execution phase of the ruleset. E.g., ddos_l4, http_request_firewall_custom, http_request_transform, http_response_headers_transform, magic_transit, etc.
ruleset_versionstringObligatorio
The specific version identifier of the entry point ruleset to fetch
accounts_or_zonesstringObligatorioenum
Scope for the ruleset: 'accounts' or 'zones'
accountszones
account_or_zone_idstringObligatorio
Identifier of the account (when accounts) or zone (when zones)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Lockdown RuleCLOUDFLARE_API_KEY_GET_LOCKDOWN_RULEAcción

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.

Parámetros de entrada

zone_idstringObligatorio
Identifier of the Cloudflare zone (max length 32)
lockdown_idstringObligatorio
Unique identifier of the Zone Lockdown rule (max length 32)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Regional Tiered CacheCLOUDFLARE_API_KEY_GET_REGIONAL_TIERED_CACHEAcción

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.

Parámetros de entrada

zone_idstringObligatorio
Identifier of the Cloudflare zone (max 32 characters)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get RulesetCLOUDFLARE_API_KEY_GET_RULESETAcción

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

Parámetros de entrada

zone_idstring
DNS zone ID; required if accounts_or_zones='zones', mutually exclusive with account_id.
account_idstring
Cloudflare account ID; required if accounts_or_zones='accounts', mutually exclusive with zone_id.
ruleset_idstringObligatorio
The unique ID of the ruleset to retrieve.
accounts_or_zonesstringObligatorioenum
Must be 'accounts' or 'zones' to select the account- or zone-level endpoint.
accountszones

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Zone DetailsCLOUDFLARE_API_KEY_GET_ZONE_DETAILSAcción

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

Parámetros de entrada

zone_idstringObligatorio
Identifier for the zone (max length 32)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List DNS RecordsCLOUDFLARE_API_KEY_LIST_DNS_RECORDSAcción

Tool to list DNS records for a given Cloudflare zone.

Parámetros de entrada

namestring
Filter by fully qualified record name in Punycode.
pageinteger
Page number (min: 1, default: 1).
typestringenum
Filter by DNS record type.
AAAAACNAMEMXTXTSRVLOCSPFCERTDNSKEYDSNAPTR+5
matchstringenum
Whether to match any or all filter requirements (default: all).
anyall
orderstringenum
Field to order by.
typenamecontentttlproxied
contentstring
Filter by record content; semantics depend on record type (e.g., IP for A, target for CNAME).
zone_idstringObligatorio
Zone identifier to list DNS records for.
per_pageinteger
Results per page (min: 5, max: 100, default: 20).
directionstringenum
Direction to order records.
ascdesc

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Cloudflare ZonesCLOUDFLARE_API_KEY_LIST_ZONESAcción

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.

Parámetros de entrada

namestring
A domain name; supports the same operators as account.name.
pageinteger
Page number (min: 1, default: 1).
matchstringenum
Whether to match any or all search requirements (default: all).
anyall
orderstringenum
Field to order by.
namestatusaccount.idaccount.nameplan.id
statusstringenum
Filter by zone status.
initializingpendingactivemoved
per_pageinteger
Results per page (min: 5, max: 50, default: 20).
directionstringenum
Direction to order zones.
ascdesc
account.idstring
Filter by an account ID.
account.namestring
Account name; supports operators: equal (default), not_equal, starts_with, ends_with, contains, starts_with_case_sensitive, ends_with_case_sensitive, contains_case_sensitive.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Overwrite DNS RecordCLOUDFLARE_API_KEY_OVERWRITE_DNS_RECORDAcción

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

Parámetros de entrada

ttlinteger
Time to live for DNS record in seconds; 1 means automatic (Cloudflare default).
namestringObligatorio
Fully qualified DNS record name in Punycode.
tagsstring[]
Custom tags in the form 'name:value'.
typestringObligatorioenum
DNS record type.
AAAAACNAMEMXTXTSRVLOCSPFCERTDNSKEYDSNAPTR+5
commentstring
Free-form comment for the DNS record.
contentstring
Record content; e.g., IPv4 address for A records, target hostname for CNAME, etc.
proxiedboolean
Whether the record is receiving the performance and security benefits of Cloudflare.
zone_idstringObligatorio
Zone identifier containing the DNS record.
settingsobject
Type-specific settings object for proxied record; passed through to the API.
dns_record_idstringObligatorio
Identifier of the DNS record to overwrite.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rerun Zone Activation CheckCLOUDFLARE_API_KEY_RERUN_ZONE_ACTIVATION_CHECKAcción

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.

Parámetros de entrada

zone_idstringObligatorio
Zone identifier (max length 32 characters)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update DNSSEC StatusCLOUDFLARE_API_KEY_UPDATE_DNSSEC_STATUSAcción

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.

Parámetros de entrada

statusstringenum
Desired DNSSEC state. Use 'active' to enable or 'disabled' to turn off DNSSEC.
activedisabled
zone_idstringObligatorio
Identifier of the zone to update.
dnssec_presignedboolean
Allow transfer-in of a pre-signed zone without on-the-fly signing.
dnssec_use_nsec3boolean
Enable NSEC3 together with DNSSEC (commonly used when transferring from another provider).
dnssec_multi_signerboolean
Enable multi-signer DNSSEC so multiple providers can serve a signed zone.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Lockdown RuleCLOUDFLARE_API_KEY_UPDATE_LOCKDOWN_RULEAcción

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.

Parámetros de entrada

urlsstring[]Obligatorio
List of URLs to include in the rule; wildcards supported.
zone_idstringObligatorio
Identifier of the Cloudflare zone.
lock_downs_idstringObligatorio
Identifier of the Zone Lockdown rule to update.
configurationsarrayObligatorio
List of allowed IP or CIDR configurations.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Rule in RulesetCLOUDFLARE_API_KEY_UPDATE_RULE_IN_RULESETAcción

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.

Parámetros de entrada

ruleobject
Fields to update on a rule.
rule_idstringObligatorio
ID of the rule to update.
positionobject
Position for reordering a rule within its ruleset.
ruleset_idstringObligatorio
ID of the ruleset containing the rule.
accounts_or_zonesstringObligatorioenum
Scope type: 'accounts' for account rulesets or 'zones' for zone rulesets.
accountszones
account_or_zone_idstringObligatorio
ID of the account or zone.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update RulesetCLOUDFLARE_API_KEY_UPDATE_RULESETAcción

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

Parámetros de entrada

kindstring
Ruleset kind (e.g., firewall); generally immutable via this endpoint.
namestring
Human-readable name for the new ruleset version.
phasestring
Execution phase of the ruleset (e.g., http_request_firewall_custom).
rulesobject[]
List of rule objects defining this ruleset version.
ruleset_idstringObligatorio
Identifier of the ruleset to update.
descriptionstring
Informative description of the new ruleset version.
accounts_or_zonesstringObligatorioenum
Scope: "accounts" to update account-level rulesets or "zones" for zone-level.
accountszones
account_or_zone_idstringObligatorio
Identifier of the account or zone depending on the scope.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Cloudflare ZoneCLOUDFLARE_API_KEY_UPDATE_ZONEAcción

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.

Parámetros de entrada

typestringenum
Zone type: 'full' (Cloudflare DNS), 'partial' (CNAME setup), or 'secondary'
fullpartialsecondary
pausedboolean
Toggle DNS-only mode; true to disable security and performance features
zone_idstringObligatorio
Identifier of the zone to update (max length 32)
vanity_name_serversstring[]
Custom nameserver domains (Business and Enterprise plans only)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload File to S3CLOUDFLARE_API_KEY_UPLOAD_FILE_TO_S3Acción

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.

Parámetros de entrada

contentstringObligatorio
Raw content of the file as a string; encoded as UTF-8 when uploaded.
mimetypestring
MIME type of the file.
file_namestringObligatorio
Filename (including extension) to store in R2/S3.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not