{"openapi":"3.1.0","info":{"title":"GitHub Secret Scanning (BYOK) API","version":"0.1.0","description":"GitHub Secret Scanning (BYOK) lets an AI assistant read your own GitHub Secret Scanning data through the GitHub Secret Scanning API with a key you supply (GitHub personal access token (security_events scope, or repo scope)). Read-only: 7 tools (list_org_secret_scanning_alerts, get_secret_scanning_alert, list_alert_locations, get_scan_history, list_repo_custom_patterns, list_org_custom_patterns,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-github-secret-scanning.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-github-secret-scanning/docs"},"termsOfService":"https://connectorbay.com/byok-github-secret-scanning/terms"},"servers":[{"url":"https://byok-github-secret-scanning.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-github-secret-scanning/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_org_secret_scanning_alerts":{"post":{"operationId":"list_org_secret_scanning_alerts","summary":"List secret scanning alerts across an organization with secret type, provider, state, validity and repository; the secre","description":"List secret scanning alerts across an organization with secret type, provider, state, validity and repository; the secret value is never returned. Use for \"Which open secret scanning alerts does octo-org have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"state":{"anyOf":[{"enum":["open","resolved"],"type":"string"},{"type":"null"}],"default":null,"description":"Only alerts in this state.","title":"State"},"secret_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated secret type names to return, for example github_personal_access_token.","title":"Secret Type"},"resolution":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated resolutions: false_positive, wont_fix, revoked, used_in_tests, pattern_edited, pattern_deleted.","title":"Resolution"},"validity":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated validities: active, inactive or unknown.","title":"Validity"},"sort":{"anyOf":[{"enum":["created","updated"],"type":"string"},{"type":"null"}],"default":"created","description":"Order by created (default) or updated.","title":"Sort"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: desc (default) or asc.","title":"Direction"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's Link header to fetch the next page.","title":"After"},"hide_secret":{"anyOf":[{"const":"true","type":"string"},{"type":"null"}],"default":"true","description":"Always true: asks GitHub to leave the secret value out of the answer (the only accepted value).","title":"Hide Secret"}},"required":["org"],"title":"list_org_secret_scanning_alertsArguments","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_secret_scanning_alert":{"post":{"operationId":"get_secret_scanning_alert","summary":"Get one repository secret scanning alert: type, provider, state, resolution, validity, leak flags and push protection by","description":"Get one repository secret scanning alert: type, provider, state, resolution, validity, leak flags and push protection bypass; the secret value is never returned. Use for \"Describe secret scanning alert 9 of octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"alert_number":{"description":"Alert number as shown at the end of the alert's URL.","title":"Alert Number","type":"integer"},"hide_secret":{"anyOf":[{"const":"true","type":"string"},{"type":"null"}],"default":"true","description":"Always true: asks GitHub to leave the secret value out of the answer (the only accepted value).","title":"Hide Secret"}},"required":["owner","repo","alert_number"],"title":"get_secret_scanning_alertArguments","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_alert_locations":{"post":{"operationId":"list_alert_locations","summary":"List where a secret scanning alert was found: file path, line and column range, and the commit and blob SHA. Use for \"In","description":"List where a secret scanning alert was found: file path, line and column range, and the commit and blob SHA. Use for \"In which files and commits was secret scanning alert 9 of octocat/Hello-World found\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"alert_number":{"description":"Alert number as shown at the end of the alert's URL.","title":"Alert Number","type":"integer"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"How many results to return (1 to 100, default 30).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["owner","repo","alert_number"],"title":"list_alert_locationsArguments","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_scan_history":{"post":{"operationId":"get_scan_history","summary":"Get a repository's secret scanning scan history: incremental, pattern update, backfill and custom pattern scans with sta","description":"Get a repository's secret scanning scan history: incremental, pattern update, backfill and custom pattern scans with status and times. Use for \"When did secret scanning last run on octocat/Hello-World\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"}},"required":["owner","repo"],"title":"get_scan_historyArguments","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_repo_custom_patterns":{"post":{"operationId":"list_repo_custom_patterns","summary":"List a repository's custom secret scanning patterns with name, state, push protection flag and version; the pattern expr","description":"List a repository's custom secret scanning patterns with name, state, push protection flag and version; the pattern expressions are left out. Use for \"Which custom secret patterns does octocat/Hello-World define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"owner":{"description":"Account that owns the repository (user or organization login), for example 'octocat'.","maxLength":200,"title":"Owner","type":"string"},"repo":{"description":"Repository name without the owner, for example 'Hello-World'.","maxLength":200,"title":"Repo","type":"string"},"state":{"anyOf":[{"enum":["published","unpublished"],"type":"string"},{"type":"null"}],"default":null,"description":"Only patterns in this state.","title":"State"},"push_protection":{"anyOf":[{"enum":["enabled","disabled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only patterns with push protection enabled or disabled.","title":"Push Protection"},"sort":{"anyOf":[{"enum":["created","updated","name"],"type":"string"},{"type":"null"}],"default":"created","description":"Order by created (default), updated or name.","title":"Sort"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: desc (default) or asc.","title":"Direction"},"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's Link header to fetch the next page.","title":"After"}},"required":["owner","repo"],"title":"list_repo_custom_patternsArguments","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_org_custom_patterns":{"post":{"operationId":"list_org_custom_patterns","summary":"List an organization's custom secret scanning patterns with name, state, push protection flag and version; the pattern e","description":"List an organization's custom secret scanning patterns with name, state, push protection flag and version; the pattern expressions are left out. Use for \"Which custom secret patterns does octo-org define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"},"state":{"anyOf":[{"enum":["published","unpublished"],"type":"string"},{"type":"null"}],"default":null,"description":"Only patterns in this state.","title":"State"},"push_protection":{"anyOf":[{"enum":["enabled","disabled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only patterns with push protection enabled or disabled.","title":"Push Protection"},"sort":{"anyOf":[{"enum":["created","updated","name"],"type":"string"},{"type":"null"}],"default":"created","description":"Order by created (default), updated or name.","title":"Sort"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction: desc (default) or asc.","title":"Direction"},"after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's Link header to fetch the next page.","title":"After"}},"required":["org"],"title":"list_org_custom_patternsArguments","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_org_pattern_configurations":{"post":{"operationId":"list_org_pattern_configurations","summary":"Get an organization's secret scanning pattern configuration: per-provider alert totals, false positive and bypass rates ","description":"Get an organization's secret scanning pattern configuration: per-provider alert totals, false positive and bypass rates and the push protection setting. Use for \"Which secret patterns in octo-org have the most false positives\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org":{"description":"Organization login, for example 'octo-org'.","maxLength":200,"title":"Org","type":"string"}},"required":["org"],"title":"list_org_pattern_configurationsArguments","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}}}}