{"openapi":"3.1.0","info":{"title":"Cloudflare Bot Protection (BYOK) API","version":"0.1.0","description":"Cloudflare Bot Protection (BYOK) lets an AI assistant read your own Cloudflare Bot Protection data through the Cloudflare Bot Protection API with a key you supply (Cloudflare API token with Turnstile and Zone WAF read permission). Read-only: 7 tools (list_turnstile_widgets, get_turnstile_widget, get_content_scanning_status, list_content_scanning_expressions, get_leaked_credential_status,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-cloudflare-bot-protection.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-cloudflare-bot-protection/docs"},"termsOfService":"https://connectorbay.com/byok-cloudflare-bot-protection/terms"},"servers":[{"url":"https://byok-cloudflare-bot-protection.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-cloudflare-bot-protection/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_turnstile_widgets":{"post":{"operationId":"list_turnstile_widgets","summary":"List Turnstile widgets of an account with sitekey, name, allowed domains, mode, region and dates. The widget secret key ","description":"List Turnstile widgets of an account with sitekey, name, allowed domains, mode, region and dates. The widget secret key is never returned. Use for \"Which Turnstile widgets do I have and on which domains\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"order":{"anyOf":[{"enum":["id","sitekey","name","created_on","modified_on"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field.","title":"Order"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction.","title":"Direction"},"filter":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only widgets whose name or sitekey matches this text.","title":"Filter"},"per_page":{"anyOf":[{"maximum":1000,"minimum":5,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (5 to 1000).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1; result_info.total_count says how many exist.","title":"Page"}},"required":["account_id"],"title":"list_turnstile_widgetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_turnstile_widget":{"post":{"operationId":"get_turnstile_widget","summary":"Get one Turnstile widget: name, domains, mode, region, clearance level and who last modified it. The widget secret key i","description":"Get one Turnstile widget: name, domains, mode, region, clearance level and who last modified it. The widget secret key is never returned. Use for \"What mode is Turnstile widget 0x4AAAAAAAAAAAAAAAAAAAAA in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"sitekey":{"description":"Turnstile widget sitekey, as returned by list_turnstile_widgets.","maxLength":64,"title":"Sitekey","type":"string"}},"required":["account_id","sitekey"],"title":"get_turnstile_widgetArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_content_scanning_status":{"post":{"operationId":"get_content_scanning_status","summary":"Show whether Content Scanning (malicious upload detection) is enabled for a zone and when the setting last changed. Use ","description":"Show whether Content Scanning (malicious upload detection) is enabled for a zone and when the setting last changed. Use for \"Is Content Scanning on for my zone\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zone_id":{"description":"Cloudflare zone id (32-character hex string, from the Cloudflare connector's list_zones).","maxLength":40,"title":"Zone Id","type":"string"}},"required":["zone_id"],"title":"get_content_scanning_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_content_scanning_expressions":{"post":{"operationId":"list_content_scanning_expressions","summary":"List the custom Content Scanning payload expressions of a zone. Use for \"Which custom expressions does Content Scanning ","description":"List the custom Content Scanning payload expressions of a zone. Use for \"Which custom expressions does Content Scanning use on my zone\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zone_id":{"description":"Cloudflare zone id (32-character hex string, from the Cloudflare connector's list_zones).","maxLength":40,"title":"Zone Id","type":"string"}},"required":["zone_id"],"title":"list_content_scanning_expressionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_leaked_credential_status":{"post":{"operationId":"get_leaked_credential_status","summary":"Show whether Leaked Credential Checks is enabled for a zone. Use for \"Are leaked credential checks enabled on my zone\".","description":"Show whether Leaked Credential Checks is enabled for a zone. Use for \"Are leaked credential checks enabled on my zone\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zone_id":{"description":"Cloudflare zone id (32-character hex string, from the Cloudflare connector's list_zones).","maxLength":40,"title":"Zone Id","type":"string"}},"required":["zone_id"],"title":"get_leaked_credential_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_leaked_credential_detections":{"post":{"operationId":"list_leaked_credential_detections","summary":"List the custom detection locations of Leaked Credential Checks: the username and password field expressions (not real c","description":"List the custom detection locations of Leaked Credential Checks: the username and password field expressions (not real credentials). Use for \"Where does my zone look for login credentials in requests\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zone_id":{"description":"Cloudflare zone id (32-character hex string, from the Cloudflare connector's list_zones).","maxLength":40,"title":"Zone Id","type":"string"}},"required":["zone_id"],"title":"list_leaked_credential_detectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_fraud_detection_settings":{"post":{"operationId":"get_fraud_detection_settings","summary":"Get the Fraud Detection settings of a zone: user profile mode, username expressions and success and failure status codes","description":"Get the Fraud Detection settings of a zone: user profile mode, username expressions and success and failure status codes. Use for \"How is Fraud Detection configured on my zone\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"zone_id":{"description":"Cloudflare zone id (32-character hex string, from the Cloudflare connector's list_zones).","maxLength":40,"title":"Zone Id","type":"string"}},"required":["zone_id"],"title":"get_fraud_detection_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}