{"openapi":"3.1.0","info":{"title":"Vercel Security (BYOK) API","version":"0.1.0","description":"Vercel Security (BYOK) lets an AI assistant read your own Vercel Security data through the Vercel Security API with a key you supply (access token). Read-only: 5 tools (get_firewall_config_version, list_bypass_rules, get_conditional_bypass_rules, list_firewall_events, get_firewall_events_summary). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vercel-security.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vercel-security/docs"},"termsOfService":"https://connectorbay.com/byok-vercel-security/terms"},"servers":[{"url":"https://byok-vercel-security.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vercel-security/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/get_firewall_config_version":{"post":{"operationId":"get_firewall_config_version","summary":"Get one version of a project's Firewall configuration: enabled flags, IP rules (action, hostname, IP, notes), custom rul","description":"Get one version of a project's Firewall configuration: enabled flags, IP rules (action, hostname, IP, notes), custom rule conditions and managed rule groups. Use for \"What IP rules does Firewall configuration version 12 contain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"config_version":{"description":"Firewall configuration version number (an integer; the active version is shown in the Vercel dashboard).","maxLength":10,"title":"Config Version","type":"string"},"project_id":{"description":"Vercel project ID (prj_...).","maxLength":100,"title":"Project Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"}},"required":["config_version","project_id"],"title":"get_firewall_config_versionArguments","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_bypass_rules":{"post":{"operationId":"list_bypass_rules","summary":"List the Firewall system bypass rules of a project (IP, domain, action, note, expiry). Use for \"Which IPs bypass my Verc","description":"List the Firewall system bypass rules of a project (IP, domain, action, note, expiry). Use for \"Which IPs bypass my Vercel Firewall\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Vercel project ID (prj_...).","maxLength":100,"title":"Project Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"},"limit":{"anyOf":[{"maximum":128,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rules to return (1 to 128).","title":"Limit"},"source_ip":{"anyOf":[{"maxLength":45,"type":"string"},{"type":"null"}],"default":null,"description":"Only rules for this IP.","title":"Source Ip"},"domain":{"anyOf":[{"maxLength":253,"type":"string"},{"type":"null"}],"default":null,"description":"Only rules for this domain.","title":"Domain"}},"required":["project_id"],"title":"list_bypass_rulesArguments","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_conditional_bypass_rules":{"post":{"operationId":"get_conditional_bypass_rules","summary":"Get the conditional bypass rules of a project (condition groups, domain, note). Use for \"Which conditional bypass rules ","description":"Get the conditional bypass rules of a project (condition groups, domain, note). Use for \"Which conditional bypass rules does my project have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Vercel project ID (prj_...).","maxLength":100,"title":"Project Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"},"domain":{"anyOf":[{"maxLength":253,"type":"string"},{"type":"null"}],"default":null,"description":"Only rules for this domain.","title":"Domain"}},"required":["project_id"],"title":"get_conditional_bypass_rulesArguments","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_firewall_events":{"post":{"operationId":"list_firewall_events","summary":"List aggregated Firewall events of a project (action, rule, host, client IP, count, time window). Page with the returned","description":"List aggregated Firewall events of a project (action, rule, host, client IP, count, time window). Page with the returned cursor. Use for \"What did my Vercel Firewall block in the last day\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Vercel project ID (prj_...).","maxLength":100,"title":"Project Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"},"start_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Start of the time range as a Unix timestamp in milliseconds.","title":"Start Timestamp"},"end_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"End of the time range as a Unix timestamp in milliseconds.","title":"End Timestamp"},"hosts":{"anyOf":[{"maxLength":253,"type":"string"},{"type":"null"}],"default":null,"description":"Only events for this hostname.","title":"Hosts"},"ip":{"anyOf":[{"maxLength":45,"type":"string"},{"type":"null"}],"default":null,"description":"Only events for this client IP address.","title":"Ip"},"rule_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only events of this rule.","title":"Rule Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many events to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.next.","title":"Cursor"}},"required":["project_id"],"title":"list_firewall_eventsArguments","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_firewall_events_summary":{"post":{"operationId":"get_firewall_events_summary","summary":"Get totals of Firewall events for a project and time range: blocked, challenged and other IP counts and breakdown by act","description":"Get totals of Firewall events for a project and time range: blocked, challenged and other IP counts and breakdown by action. Use for \"How many IPs did my Vercel Firewall block this week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Vercel project ID (prj_...).","maxLength":100,"title":"Project Id","type":"string"},"team_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Team ID (starts with 'team_') to act on behalf of; omit to use the personal account.","title":"Team Id"},"start_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Start of the time range as a Unix timestamp in milliseconds.","title":"Start Timestamp"},"end_timestamp":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"End of the time range as a Unix timestamp in milliseconds.","title":"End Timestamp"},"hosts":{"anyOf":[{"maxLength":253,"type":"string"},{"type":"null"}],"default":null,"description":"Only events for this hostname.","title":"Hosts"},"ip":{"anyOf":[{"maxLength":45,"type":"string"},{"type":"null"}],"default":null,"description":"Only events for this client IP address.","title":"Ip"}},"required":["project_id"],"title":"get_firewall_events_summaryArguments","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}}}}