{"openapi":"3.1.0","info":{"title":"GitGuardian (BYOK) API","version":"0.1.0","description":"GitGuardian (BYOK) lets an AI assistant read your own GitGuardian data through the GitGuardian API with a key you supply (GitGuardian service account or personal access token (read scopes)). Read-only: 8 tools (check_api_key, get_current_token, get_scan_quota, list_secret_incidents, get_secret_incident, list_sources, list_teams, list_team_sources). The BYOK key travels with each request, is used...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gitguardian.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gitguardian/docs"},"termsOfService":"https://connectorbay.com/byok-gitguardian/terms"},"servers":[{"url":"https://byok-gitguardian.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gitguardian/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/check_api_key":{"post":{"operationId":"check_api_key","summary":"Check that the key is valid by calling the GitGuardian health endpoint; returns the detail message. Use for \"Is my GitGu","description":"Check that the key is valid by calling the GitGuardian health endpoint; returns the detail message. Use for \"Is my GitGuardian API key valid\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"check_api_keyArguments","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_current_token":{"post":{"operationId":"get_current_token","summary":"Show details of the API key in use: name, type, status, scopes, creation, last use and expiry (the token value is not re","description":"Show details of the API key in use: name, type, status, scopes, creation, last use and expiry (the token value is not returned). Use for \"Which scopes does my GitGuardian key have and when does it expire\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_tokenArguments","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_quota":{"post":{"operationId":"get_scan_quota","summary":"Show the scan API quota of the workspace: calls used, limit, remaining and the rolling period start. Reading incidents d","description":"Show the scan API quota of the workspace: calls used, limit, remaining and the rolling period start. Reading incidents does not use this quota. Use for \"How much GitGuardian scan quota do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_scan_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}},"/v1/tools/list_secret_incidents":{"post":{"operationId":"list_secret_incidents","summary":"List secret incidents of the workspace with detector, status, severity, validity, occurrence count and dashboard link; f","description":"List secret incidents of the workspace with detector, status, severity, validity, occurrence count and dashboard link; filter by status, severity, validity, dates and tags. Needs the incidents:read scope. Secret values and hashes are never part of the answer. Use for \"Which critical GitGuardian secret incidents are still open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"severity":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated severities: critical, high, medium, low, info, unknown.","title":"Severity"},"status":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated statuses: TRIGGERED, ASSIGNED, RESOLVED, IGNORED.","title":"Status"},"validity":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated validity values: valid, invalid, failed_to_check, no_checker, not_checked.","title":"Validity"},"from_date":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only incidents detected on or after this ISO 8601 date, for example 2026-09-01.","title":"From Date"},"to_date":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only incidents detected on or before this ISO 8601 date.","title":"To Date"},"tags":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated incident tags, for example PUBLICLY_EXPOSED.","title":"Tags"},"ordering":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field, for example date or -date (newest first).","title":"Ordering"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100). Only the first page is returned.","title":"Per Page"}},"title":"list_secret_incidentsArguments","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_incident":{"post":{"operationId":"get_secret_incident","summary":"Get one secret incident by id: detector, status, severity, validity, occurrence count, revocation state and dashboard li","description":"Get one secret incident by id: detector, status, severity, validity, occurrence count, revocation state and dashboard link. Needs the incidents:read scope. Secret values and hashes are never part of the answer. Use for \"Show GitGuardian secret incident 1234\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"incident_id":{"description":"Incident id, a number as returned by list_secret_incidents.","maximum":2147483647,"minimum":1,"title":"Incident Id","type":"integer"}},"required":["incident_id"],"title":"get_secret_incidentArguments","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_sources":{"post":{"operationId":"list_sources","summary":"List the monitored sources (repositories) with type, visibility, health, criticality, open and closed incident counts an","description":"List the monitored sources (repositories) with type, visibility, health, criticality, open and closed incident counts and last scan status. Needs the sources:read scope. Use for \"Which monitored repositories are at risk in GitGuardian\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sources whose name contains this text.","title":"Search"},"health":{"anyOf":[{"enum":["safe","unknown","at_risk"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sources with this health.","title":"Health"},"type":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only sources of this type, for example github, gitlab or bitbucket.","title":"Type"},"visibility":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only sources with this visibility, for example public, private or internal.","title":"Visibility"},"source_criticality":{"anyOf":[{"enum":["critical","high","medium","low","unknown"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sources with this criticality.","title":"Source Criticality"},"monitored":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True or false: only monitored or unmonitored sources.","title":"Monitored"},"last_scan_status":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only sources whose last scan has this status, for example finished or failed.","title":"Last Scan Status"},"team_id":{"anyOf":[{"maximum":2147483647,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only sources within this team's perimeter (team id, number).","title":"Team Id"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100). Only the first page is returned.","title":"Per Page"}},"title":"list_sourcesArguments","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_teams":{"post":{"operationId":"list_teams","summary":"List the workspace teams with name, description and whether the team is the global team. Use for \"Which teams exist in m","description":"List the workspace teams with name, description and whether the team is the global team. Use for \"Which teams exist in my GitGuardian workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only teams whose name contains this text.","title":"Search"},"is_global":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only the global team.","title":"Is Global"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100). Only the first page is returned.","title":"Per Page"}},"title":"list_teamsArguments","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_team_sources":{"post":{"operationId":"list_team_sources","summary":"List the sources that belong to one team with type, visibility, health, criticality and incident counts. Use for \"Which ","description":"List the sources that belong to one team with type, visibility, health, criticality and incident counts. Use for \"Which repositories does team 5 own in GitGuardian\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Team id, a number as returned by list_teams.","maximum":2147483647,"minimum":1,"title":"Team Id","type":"integer"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sources whose name contains this text.","title":"Search"},"health":{"anyOf":[{"enum":["safe","unknown","at_risk"],"type":"string"},{"type":"null"}],"default":null,"description":"Only sources with this health.","title":"Health"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 100). Only the first page is returned.","title":"Per Page"}},"required":["team_id"],"title":"list_team_sourcesArguments","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}}}}