{"openapi":"3.1.0","info":{"title":"Cloudflare DEX (BYOK) API","version":"0.1.0","description":"Cloudflare DEX (BYOK) lets an AI assistant read your own Cloudflare DEX data through the Cloudflare DEX API with a key you supply (Cloudflare API token with Zero Trust read permission). Read-only: 6 tools (list_dex_tests, get_dex_test, get_tests_overview, get_fleet_status_live, list_colos, get_remote_commands_quota). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-cloudflare-dex.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-cloudflare-dex/docs"},"termsOfService":"https://connectorbay.com/byok-cloudflare-dex/terms"},"servers":[{"url":"https://byok-cloudflare-dex.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-cloudflare-dex/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_dex_tests":{"post":{"operationId":"list_dex_tests","summary":"List DEX synthetic tests (HTTP and traceroute) with target host, interval, enabled flag and dates. Use for \"Which DEX sy","description":"List DEX synthetic tests (HTTP and traceroute) with target host, interval, enabled flag and dates. Use for \"Which DEX synthetic tests run on my devices\".","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"},"test_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only tests with this name.","title":"Test Name"},"kind":{"anyOf":[{"enum":["http","traceroute"],"type":"string"},{"type":"null"}],"default":null,"description":"Only tests of this kind.","title":"Kind"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many tests per page (1 to 50).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["account_id"],"title":"list_dex_testsArguments","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_dex_test":{"post":{"operationId":"get_dex_test","summary":"Get one DEX synthetic test with target host, interval, enabled flag and dates. Use for \"Show DEX test 372e67954025e0ba6a","description":"Get one DEX synthetic test with target host, interval, enabled flag and dates. Use for \"Show DEX test 372e67954025e0ba6aaa6d586b9e0b59\".","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"},"dex_test_id":{"description":"DEX test id, as returned by list_dex_tests.","maxLength":64,"title":"Dex Test Id","type":"string"}},"required":["account_id","dex_test_id"],"title":"get_dex_testArguments","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_tests_overview":{"post":{"operationId":"get_tests_overview","summary":"Get availability analytics of DEX tests: average HTTP and traceroute availability percentages, number of tests and the p","description":"Get availability analytics of DEX tests: average HTTP and traceroute availability percentages, number of tests and the per-test result summaries. Aggregate figures only: no per-device or per-user records are returned. Use for \"How available are my DEX tests\".","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"},"test_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only tests with this name.","title":"Test Name"},"kind":{"anyOf":[{"enum":["http","traceroute"],"type":"string"},{"type":"null"}],"default":null,"description":"Only tests of this kind.","title":"Kind"},"colo":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only results from this Cloudflare colo code, for example 'SJC'.","title":"Colo"},"per_page":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many tests per page (1 to 50).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["account_id"],"title":"get_tests_overviewArguments","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_fleet_status_live":{"post":{"operationId":"get_fleet_status_live","summary":"Get live aggregate counts of WARP devices by colo, mode, platform, status and client version for the last few minutes. A","description":"Get live aggregate counts of WARP devices by colo, mode, platform, status and client version for the last few minutes. Aggregate figures only: no per-device or per-user records are returned. Use for \"How many devices are connected right now and on which platforms\".","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"},"since_minutes":{"anyOf":[{"maximum":60,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many minutes back to look (1 to 60).","title":"Since Minutes"}},"required":["account_id"],"title":"get_fleet_status_liveArguments","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_colos":{"post":{"operationId":"list_colos","summary":"List the Cloudflare colos (airport code, city, country) seen by DEX in a time period, optionally sorted by usage. Use fo","description":"List the Cloudflare colos (airport code, city, country) seen by DEX in a time period, optionally sorted by usage. Use for \"Which Cloudflare colos did my devices use last week\".","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"},"from_time":{"description":"Start of the period, ISO 8601 / RFC 3339, for example 2026-10-01T00:00:00Z.","maxLength":40,"title":"From Time","type":"string"},"to_time":{"description":"End of the period, ISO 8601 / RFC 3339, for example 2026-10-08T00:00:00Z.","maxLength":40,"title":"To Time","type":"string"},"sort_by":{"anyOf":[{"enum":["fleet-status-usage","application-tests-usage"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort colos by fleet-status-usage or application-tests-usage.","title":"Sort By"}},"required":["account_id","from_time","to_time"],"title":"list_colosArguments","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_remote_commands_quota":{"post":{"operationId":"get_remote_commands_quota","summary":"Show the account's DEX remote commands usage, quota and reset time. Use for \"How many DEX remote commands have I used th","description":"Show the account's DEX remote commands usage, quota and reset time. Use for \"How many DEX remote commands have I used this period\".","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"}},"required":["account_id"],"title":"get_remote_commands_quotaArguments","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}}}}