{"openapi":"3.1.0","info":{"title":"Cloudflare Health Checks (BYOK) API","version":"0.1.0","description":"Cloudflare Health Checks (BYOK) lets an AI assistant read your own Cloudflare Health Checks data through the Cloudflare Health Checks API with a key you supply (Cloudflare API token with Health Checks read permission). Read-only: 5 tools (list_health_checks, get_health_check, get_health_check_preview, list_smart_shield_health_checks, get_smart_shield_health_check). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-cloudflare-health-checks.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-cloudflare-health-checks/docs"},"termsOfService":"https://connectorbay.com/byok-cloudflare-health-checks/terms"},"servers":[{"url":"https://byok-cloudflare-health-checks.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-cloudflare-health-checks/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_health_checks":{"post":{"operationId":"list_health_checks","summary":"List the Health Checks of a zone with target address, type, current status, failure reason, interval, probe regions and ","description":"List the Health Checks of a zone with target address, type, current status, failure reason, interval, probe regions and HTTP settings. Use for \"Are my Cloudflare health checks healthy\".","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"},"per_page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 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":["zone_id"],"title":"list_health_checksArguments","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_health_check":{"post":{"operationId":"get_health_check","summary":"Get one Health Check: address, type, status, failure reason, interval, retries, timeout and probe regions. Use for \"Why ","description":"Get one Health Check: address, type, status, failure reason, interval, retries, timeout and probe regions. Use for \"Why is health check 699d9864 unhealthy\".","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"},"healthcheck_id":{"description":"Health check id (32-character hex string), as returned by the list tools.","maxLength":40,"title":"Healthcheck Id","type":"string"}},"required":["zone_id","healthcheck_id"],"title":"get_health_checkArguments","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_health_check_preview":{"post":{"operationId":"get_health_check_preview","summary":"Get a Health Check preview by id (the configuration as it would run, with the same fields as a health check). Use for \"W","description":"Get a Health Check preview by id (the configuration as it would run, with the same fields as a health check). Use for \"What would health check preview 699d9864 monitor\".","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"},"healthcheck_id":{"description":"Health check id (32-character hex string), as returned by the list tools.","maxLength":40,"title":"Healthcheck Id","type":"string"}},"required":["zone_id","healthcheck_id"],"title":"get_health_check_previewArguments","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_smart_shield_health_checks":{"post":{"operationId":"list_smart_shield_health_checks","summary":"List the Smart Shield health checks of a zone with target, status, failure reason and probe settings. Use for \"Which Sma","description":"List the Smart Shield health checks of a zone with target, status, failure reason and probe settings. Use for \"Which Smart Shield health checks are failing\".","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"},"per_page":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 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":["zone_id"],"title":"list_smart_shield_health_checksArguments","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_smart_shield_health_check":{"post":{"operationId":"get_smart_shield_health_check","summary":"Get one Smart Shield health check with status, failure reason and probe settings. Use for \"What is the status of Smart S","description":"Get one Smart Shield health check with status, failure reason and probe settings. Use for \"What is the status of Smart Shield health check 699d9864\".","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"},"healthcheck_id":{"description":"Health check id (32-character hex string), as returned by the list tools.","maxLength":40,"title":"Healthcheck Id","type":"string"}},"required":["zone_id","healthcheck_id"],"title":"get_smart_shield_health_checkArguments","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}}}}