{ "openapi": "3.0.1", "info": { "title": "Cloudflare API - DNS, Zones, Cache & Security", "description": "Manage your Cloudflare infrastructure programmatically. Configure DNS records, manage zones, purge cache, set up page rules, and control security settings through a single interface.\n\nFeatures\nZone Management\nDNS Management\nCache Control\nPage Rules\nSecurity & Analytics", "version": "1.0", "x-build-id": "OocCeh5mP1rfvNSYH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~cloudflare-api---dns-zones-cache-security/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-cloudflare-api---dns-zones-cache-security", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~cloudflare-api---dns-zones-cache-security/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-cloudflare-api---dns-zones-cache-security", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~cloudflare-api---dns-zones-cache-security/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-cloudflare-api---dns-zones-cache-security", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "list_zones", "get_zone", "list_dns_records", "get_dns_record", "create_dns_record", "update_dns_record", "delete_dns_record", "purge_cache", "purge_cache_by_url", "list_page_rules", "create_page_rule", "delete_page_rule", "get_zone_settings", "update_zone_setting", "get_analytics", "list_firewall_rules", "get_user" ], "type": "string", "description": "The operation to perform on Cloudflare", "default": "list_zones" }, "zoneId": { "title": "Zone ID", "type": "string", "description": "Cloudflare zone ID (found in zone overview dashboard)" }, "zoneName": { "title": "Zone Name", "type": "string", "description": "Domain name to look up zone ID (alternative to zoneId)" }, "recordId": { "title": "DNS Record ID", "type": "string", "description": "DNS record ID for get/update/delete operations" }, "recordType": { "title": "DNS Record Type", "enum": [ "A", "AAAA", "CNAME", "TXT", "MX", "NS", "SRV", "CAA", "PTR" ], "type": "string", "description": "Type of DNS record", "default": "A" }, "recordName": { "title": "DNS Record Name", "type": "string", "description": "DNS record name (e.g., 'www', '@' for root, or full domain)" }, "recordContent": { "title": "DNS Record Content", "type": "string", "description": "DNS record content/value (e.g., IP address, target domain)" }, "recordTtl": { "title": "DNS Record TTL", "type": "integer", "description": "Time to live in seconds (1 = automatic)", "default": 1 }, "recordProxied": { "title": "Proxied through Cloudflare", "type": "boolean", "description": "Whether traffic is proxied through Cloudflare (orange cloud)", "default": true }, "recordPriority": { "title": "MX Priority", "type": "integer", "description": "Priority for MX records" }, "purgeUrls": { "title": "URLs to Purge", "type": "string", "description": "Comma-separated URLs to purge from cache" }, "pageRuleUrl": { "title": "Page Rule URL Pattern", "type": "string", "description": "URL pattern for page rule (e.g., '*example.com/images/*')" }, "pageRuleActions": { "title": "Page Rule Actions (JSON)", "type": "string", "description": "JSON array of page rule actions" }, "settingId": { "title": "Setting ID", "type": "string", "description": "Zone setting to update (e.g., 'ssl', 'always_use_https', 'minify')" }, "settingValue": { "title": "Setting Value", "type": "string", "description": "New value for the setting" }, "analyticsStartDate": { "title": "Analytics Start Date", "type": "string", "description": "Start date for analytics (ISO format)" }, "analyticsEndDate": { "title": "Analytics End Date", "type": "string", "description": "End date for analytics (ISO format)" }, "apiToken": { "title": "Cloudflare API Token", "type": "string", "description": "Cloudflare API token with appropriate permissions" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to receive results via webhook for automation platforms" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data for testing (no API calls made)", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }