Security — entry 013 of 30
GitGuardian
GitGuardian continuously scans source code, commit history, and CI/CD pipelines for hardcoded secrets — API keys, database credentials, private certificates — before they leak into production or a public repository. The public API lets teams pull incidents, drive remediation workflows, and wire secret detection into their own tooling, authenticated with a bearer token issued from a workspace API key. A free tier covers small teams, with paid Business and Enterprise plans unlocking higher scan volume and governance controls.
AuthenticationAPI KeySign up with the provider to obtain credentials.
HTTPSSupportedTraffic is encrypted in transit.
CORSDisabledBrowser calls need a server-side proxy.
PricingFreemiumA usable free tier exists, with paid plans for more volume.
FormatsJSONResponses can be requested as JSON.
GreatAPIs Score
Score81
Authentication15/25API key required
Pricing17/20Freemium tier available
Docs20/20Machine-readable spec file bundled
Formats9/15Single response format
Freshness20/20Verified within 6 months
Embed this badge
<a href="https://greatapis.com/api/gitguardian/"><img src="https://greatapis.com/badge/gitguardian.svg" alt="Scored 81 on greatapis.com"></a>Auth quickstart
- Get a key at the provider
- Send it on every request as a header
Authorization: Token <key>
Stored keyNo key stored
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
API Tokens7
Manage API tokens.
GET/v1/api_tokensList API tokens.
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
status | query | no | — |
member_id | query | no | integer |
creator_id | query | no | integer |
scopes | query | no | string |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | API tokens list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
POST/v1/api_tokensCreate an API token.
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
201 | API token created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
409 | Another token is already being created for this member or workspace. The call can be retried after a few seconds. | — |
GET/v1/api_tokens/selfRetrieve details of the current API token.
Responses
| Status | Description | Schema |
|---|---|---|
200 | Current token details | — |
401 | Invalid API key | — |
DELETE/v1/api_tokens/selfRevoke the current API token.
Responses
| Status | Description | Schema |
|---|---|---|
204 | Token revocation confirmation | — |
401 | Invalid API key | — |
GET/v1/api_tokens/{token_id}Retrieve details of an API token.
Parameters
| Name | In | Required | Type |
|---|---|---|---|
token_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Current token details | — |
401 | Invalid API key | — |
404 | API token not found | — |
DELETE/v1/api_tokens/{token_id}Revoke an API token.
Parameters
| Name | In | Required | Type |
|---|---|---|---|
token_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Token revocation confirmation | — |
401 | Invalid API key | — |
404 | API token not found | — |
POST/v1/auth/jwtCreate a JSON Web Token.
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Created JWT | — |
400 | Invalid data | — |
401 | Invalid API key | — |
Internal Secret Locations2
Retrieve the files that still hold a secret on the default branch of your sources, to know where the code has to change.
GET/v1/incidents/secrets/{incident_id}/locationsList locations of a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
source | query | no | string |
active | query | no | boolean |
number_of_mentions_min | query | no | integer |
number_of_mentions_max | query | no | integer |
code_fix_request_status | query | no | string |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Location List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
503 | API under maintenance | — |
GET/v1/sources/{source_id}/locationsList locations of a source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
source_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
active | query | no | boolean |
number_of_mentions_min | query | no | integer |
number_of_mentions_max | query | no | integer |
code_fix_request_status | query | no | string |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Source Location List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource not found | — |
503 | API under maintenance | — |
Secret Detectors2
Retrieve details on detectors used for secret detection.
GET/v1/secret_detectorsList secret detectors
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
is_active | query | no | boolean |
type | query | no | — |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of Secret Detectors | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
503 | API under maintenance | — |
GET/v1/secret_detectors/{detector_name}Get a secret detector
Parameters
| Name | In | Required | Type |
|---|---|---|---|
detector_name | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Detector | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Secret Detector not found | — |
503 | API under maintenance | — |
Severity Rules1
List the severity rules that determine how incident severity is automatically assigned.
GET/v1/severity-rulesList severity rules
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of Severity Rules | — |
401 | Invalid API key | — |
403 | Permission denied | — |
503 | API under maintenance | — |
Secrets3
Access information about individual secrets detected by GitGuardian.
GET/v1/secrets/{secret_id}/validityGet the validity of a secret
Parameters
| Name | In | Required | Type |
|---|---|---|---|
secret_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | The secret validity and validity override. | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
POST/v1/secrets/{secret_id}/validityOverride the validity of a secret
Parameters
| Name | In | Required | Type |
|---|---|---|---|
secret_id | path | yes | integer |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | The validity override was set. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
DELETE/v1/secrets/{secret_id}/validityRemove the validity override of a secret
Parameters
| Name | In | Required | Type |
|---|---|---|---|
secret_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The validity override was removed. | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
Code Fixing1
Create automated code fix requests to remediate detected secrets via pull requests.
POST/v1/code-fix-requestsCreate code fix requests
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
201 | Code fix request(s) created successfully | — |
400 | Bad Request - Invalid input or business rule violation | — |
401 | Invalid API key | — |
403 | Forbidden - Insufficient permissions | — |
404 | Not Found - API key not configured (on-prem only) | — |
503 | API under maintenance | — |
Invitations9
Manage workspace invitations.
GET/v1/invitationsList invitations
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List invitations | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
503 | API under maintenance | — |
POST/v1/invitationsCreate an invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Invitation sent | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/invitations/{invitation_id}Retrieve an invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Invitation details. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Invitation not found | — |
503 | API under maintenance | — |
DELETE/v1/invitations/{invitation_id}Delete an invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The invitation was deleted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Invitation not found | — |
503 | API under maintenance | — |
POST/v1/invitations/{invitation_id}/resendResend an invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Invitation sent | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Invitation not found | — |
429 | Too many requests | — |
503 | API under maintenance | — |
GET/v1/invitations/{invitation_id}/secret-incidentsList secret incidents an invitation has access to
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
feedback | query | no | boolean |
only_on_provider_archived_sources | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Invitation not found | — |
503 | API under maintenance | — |
GET/v1/invitations/{invitation_id}/{resource_type}/{resource_id}Check invitation permission for a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Invitation Resource access details | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Invitation not found | — |
503 | API under maintenance | — |
PUT/v1/invitations/{invitation_id}/{resource_type}/{resource_id}Give an invitation access to a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | The access was updated successfully. | — |
201 | The access was granted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Invitation not found | — |
503 | API under maintenance | — |
DELETE/v1/invitations/{invitation_id}/{resource_type}/{resource_id}Revoke an invitation's access to a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
invitation_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
204 | The access was revoked successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Invitation not found | — |
503 | API under maintenance | — |
Sources10
Retrieve details on sources known by GitGuardian.
GET/v1/scans/{scan_id}/live-progressRetrieve a scan's live progress
Parameters
| Name | In | Required | Type |
|---|---|---|---|
scan_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Scan live progress | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Scan not found | — |
503 | API under maintenance | — |
GET/v1/sourcesList sources
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
search | query | no | string |
last_scan_status | query | no | — |
health | query | no | — |
type | query | no | string |
ordering | query | no | string |
visibility | query | no | string |
external_id | query | no | string |
source_criticality | query | no | string |
monitored | query | no | boolean |
provider_metadata_archived | query | no | boolean |
team_id | query | no | integer |
monitoring_status__in | query | no | string |
monitoring_status__nin | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Source List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/sources/custom-sourcesList custom sources
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Custom Source List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/sources/custom-sourcesCreate custom source
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Custom source created successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden | — |
503 | API under maintenance | — |
GET/v1/sources/custom-sources/{custom_source_id}Get a custom source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_source_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Custom source detail | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Resource not found | — |
503 | API under maintenance | — |
PATCH/v1/sources/custom-sources/{custom_source_id}Update a custom source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_source_id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The custom source was updated successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
DELETE/v1/sources/custom-sources/{custom_source_id}Delete a custom source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_source_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The custom source was deleted successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
POST/v1/sources/scansTrigger scans on sources
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted – scans have been queued. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden | — |
503 | API under maintenance | — |
GET/v1/sources/{source_id}Retrieve a source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
source_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Source detail | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
PATCH/v1/sources/{source_id}Update a source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
source_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The source was updated successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Members12
Retrieve details about workspace members.
GET/v1/membersList members
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
role | query | no | — |
access_level | query | no | — |
active | query | no | boolean |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List members | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/members/{member_id}Retrieve a member
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Workspace member details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Member not found | — |
503 | API under maintenance | — |
PATCH/v1/members/{member_id}Update a member
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Workspace member details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Member not found | — |
503 | API under maintenance | — |
DELETE/v1/members/{member_id}Delete a member
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
send_email | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The member was deleted successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Member not found | — |
503 | API under maintenance | — |
GET/v1/members/{member_id}/email_notificationsRetrieve a member's email settings
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member notification settings | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Member not found | — |
503 | API under maintenance | — |
PATCH/v1/members/{member_id}/email_notificationsUpdate a member's email settings
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member notification settings | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Member not found | — |
503 | API under maintenance | — |
GET/v1/members/{member_id}/secret-incidentsList secret incidents a member has access to
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
feedback | query | no | boolean |
only_on_provider_archived_sources | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Member not found | — |
503 | API under maintenance | — |
GET/v1/members/{member_id}/team_membershipsList team memberships of a member
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
member_id | path | yes | integer |
team_id | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team membership list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
GET/v1/members/{member_id}/teamsList teams of a member
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
search | query | no | string |
is_global | query | no | boolean |
member_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List teams | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Not found | — |
503 | API under maintenance | — |
GET/v1/members/{member_id}/{resource_type}/{resource_id}Check member permission for a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member resource access details | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Member not found | — |
503 | API under maintenance | — |
PUT/v1/members/{member_id}/{resource_type}/{resource_id}Give a member access to a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | The access was updated successfully. | — |
201 | The access was granted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Member not found | — |
503 | API under maintenance | — |
DELETE/v1/members/{member_id}/{resource_type}/{resource_id}Revoke a member's access to a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
member_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
204 | The access was revoked successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Member not found | — |
503 | API under maintenance | — |
Scan Methods3
Use GitGuardian's brain at your leisure. Scanning API allows you to scan any content you want using GitGuardian's secrets detection algorithms.
POST/v1/multiscanMultiple content scan
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful Scan | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Quota limit reached | — |
503 | API under maintenance | — |
POST/v1/scanContent scan
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful Scan | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Quota limit reached | — |
503 | API under maintenance | — |
POST/v1/scan/create-incidentsScan content and create incidents
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful Scan and Incident Creation | — |
400 | Bad Request | — |
401 | Invalid API key | — |
403 | Forbidden | — |
503 | API under maintenance | — |
Quota1
Retrieve details about quota usage.
GET/v1/quotasQuota overview
Responses
| Status | Description | Schema |
|---|---|---|
200 | Quota Overview | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Status1
Check the status of the API and the overall system health.
GET/v1/healthAPI Health
Responses
| Status | Description | Schema |
|---|---|---|
200 | API on and key valid response | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Teams9
Manage teams.
GET/v1/teamsList teams
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
is_global | query | no | boolean |
search | query | no | string |
linked_to_an_external_provider | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List teams | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
503 | API under maintenance | — |
POST/v1/teamsCreate a team
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Team created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/teams/{team_id}Retrieve a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Team not found | — |
503 | API under maintenance | — |
PATCH/v1/teams/{team_id}Update a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The team was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
DELETE/v1/teams/{team_id}Delete a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The team was deleted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Team not found | — |
503 | API under maintenance | — |
GET/v1/teams/{team_id}/secret-incidentsList secret incidents a team has access to
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
custom_tags | query | no | string |
custom_tag_key | query | no | string |
custom_tag_value | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
feedback | query | no | boolean |
only_on_provider_archived_sources | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Team not found | — |
503 | API under maintenance | — |
GET/v1/teams/{team_id}/{resource_type}/{resource_id}Check team permission for a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team Secret resource access details | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Team not found | — |
503 | API under maintenance | — |
PUT/v1/teams/{team_id}/{resource_type}/{resource_id}Give a team access to a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | The access was updated successfully. | — |
201 | The access was granted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Team not found | — |
503 | API under maintenance | — |
DELETE/v1/teams/{team_id}/{resource_type}/{resource_id}Revoke a team's access to a resource
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
resource_type | path | yes | string |
resource_id | path | yes | integer |
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
204 | The access was revoked successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource or Team not found. | — |
503 | API under maintenance | — |
Team Invitations4
Manage team invitations.
GET/v1/teams/{team_id}/team_invitationsList team invitations
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
team_id | path | yes | integer |
invitation_id | query | no | integer |
is_team_leader | query | no | boolean |
team_permission | query | no | string |
incident_permission | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team invitation list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
POST/v1/teams/{team_id}/team_invitationsCreate a team invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Team invitation created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
409 | Data conflict | — |
503 | API under maintenance | — |
PATCH/v1/teams/{team_id}/team_invitations/{team_invitation_id}Update a team invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
team_invitation_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team invitation was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
DELETE/v1/teams/{team_id}/team_invitations/{team_invitation_id}Delete a team invitation
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
team_invitation_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Team invitation was deleted successfully. | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
Team Memberships4
Add or remove members from teams, or update their permissions.
GET/v1/teams/{team_id}/team_membershipsList team memberships
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
team_id | path | yes | integer |
is_team_leader | query | no | boolean |
team_permission | query | no | string |
incident_permission | query | no | string |
member_id | query | no | number |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team membership list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
POST/v1/teams/{team_id}/team_membershipsAdd a member to a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Team membership created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
409 | Data conflict | — |
503 | API under maintenance | — |
PATCH/v1/teams/{team_id}/team_memberships/{team_membership_id}Update a team membership
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
team_membership_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team membership was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
DELETE/v1/teams/{team_id}/team_memberships/{team_membership_id}Remove a member from a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
team_membership_id | path | yes | integer |
send_email | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Team membership was deleted successfully. | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
Health Checks3
Monitor the health of integration instances.
GET/v1/health-checksList health checks
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
type | query | no | string |
status | query | no | string |
started_at_after | query | no | string |
started_at_before | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Health check list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
503 | API under maintenance | — |
GET/v1/health-checks/{type}/{instance_id}List health check history for an instance
Parameters
| Name | In | Required | Type |
|---|---|---|---|
type | path | yes | string |
instance_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
status | query | no | string |
started_at_after | query | no | string |
started_at_before | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Health check instance history | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource not found | — |
503 | API under maintenance | — |
POST/v1/health-checks/{type}/{instance_id}/triggerTrigger a health check
Parameters
| Name | In | Required | Type |
|---|---|---|---|
type | path | yes | string |
instance_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Health check enqueued successfully | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Resource not found | — |
429 | Health check triggered too recently | — |
503 | API under maintenance | — |
Honeytokens11
Manage honeytokens.
GET/v1/honeytokensList honeytokens
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
status | query | no | string |
type | query | no | string |
search | query | no | string |
creator_id | query | no | number |
revoker_id | query | no | number |
creator_api_token_id | query | no | string |
revoker_api_token_id | query | no | string |
tags | query | no | string |
ordering | query | no | string |
show_token | query | no | boolean |
X-Privacy-Mode | header | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List honeytokens | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
503 | API under maintenance | — |
POST/v1/honeytokensCreate a honeytoken
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Honeytoken created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/honeytokens/endpoint-deploymentsList a machine/user's honeytoken deployments (read-only)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
machine_id | query | yes | string |
username | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | The live honeytoken placements for this machine/user (possibly empty). | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
503 | API under maintenance | — |
POST/v1/honeytokens/endpoint-deploymentsReconcile (plant) honeytokens for a machine/user
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The desired honeytoken placements for this machine/user. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
409 | The request carried an explicit `config` that conflicts with an already-active deployment for the same `(machine, user, method)`. Revoke it before changing the config. | — |
503 | API under maintenance | — |
PATCH/v1/honeytokens/endpoint-deployments/{id}Confirm a honeytoken endpoint deployment
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Deployment updated | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Resource not found | — |
503 | API under maintenance | — |
POST/v1/honeytokens/prefixesBulk prefix lookup for honeytoken HMSL hashes
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Matching honeytoken hints | — |
400 | Invalid request (bad prefix format or too many prefixes) | — |
401 | Invalid API key | — |
403 | Forbidden | — |
POST/v1/honeytokens/with-contextCreate a honeytoken within a context
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken within a context created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/honeytokens/{honeytoken_id}Retrieve a honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
X-Privacy-Mode | header | no | string |
show_token | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Honeytoken not found | — |
503 | API under maintenance | — |
PATCH/v1/honeytokens/{honeytoken_id}Update a honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
X-Privacy-Mode | header | no | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The honeytoken was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/honeytokens/{honeytoken_id}/resetReset the honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
X-Privacy-Mode | header | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken was successfully revoked. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/honeytokens/{honeytoken_id}/revokeRevoke the honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
X-Privacy-Mode | header | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken was successfully revoked. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Honeytoken Notes4
Manage notes on honeytokens.
GET/v1/honeytokens/{honeytoken_id}/notesList notes on an honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
member_id | query | no | integer |
api_token_id | query | no | string |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken Note List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Honeytoken not found | — |
503 | API under maintenance | — |
POST/v1/honeytokens/{honeytoken_id}/notesCreate an honeytoken note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | The note was created successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Honeytoken not found. | — |
503 | API under maintenance | — |
PATCH/v1/honeytokens/{honeytoken_id}/notes/{note_id}Update a honeytoken note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
note_id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The note was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | You cannot update an Honeytoken Note you that was not created by the current API key. | — |
404 | Honeytoken or Honeytoken Note not found. | — |
503 | API under maintenance | — |
DELETE/v1/honeytokens/{honeytoken_id}/notes/{note_id}Delete a honeytoken note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
note_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The note was deleted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | You cannot delete an Honeytoken Note you that was not created by the current API key. | — |
404 | Honeytoken or Honeytoken Note not found. | — |
503 | API under maintenance | — |
Honeytokens Events1
Manage events on honeytokens.
GET/v1/honeytokens_eventsList all honeytokens events
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
honeytoken_id | query | no | string |
status | query | no | string |
ip_address | query | no | string |
tags | query | no | string |
search | query | no | string |
X-Privacy-Mode | header | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytokens Events List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Honeytoken Sources1
Manage sources on honeytokens.
GET/v1/honeytokens/{honeytoken_id}/sourcesList sources on an honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
provider_metadata_archived | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken Sources List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Honeytoken not found | — |
503 | API under maintenance | — |
IP Allowlist5
Manage the IP allowlist for workspace access. Only available on SaaS.
GET/v1/ip-allowlistList IP allowlist rules
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List IP allowlist rules | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
503 | API under maintenance | — |
POST/v1/ip-allowlistCreate an IP allowlist rule
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | IP allowlist rule created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/ip-allowlist/{ip_allowlist_rule_id}Retrieve an IP allowlist rule
Parameters
| Name | In | Required | Type |
|---|---|---|---|
ip_allowlist_rule_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | IP allowlist rule details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | IP allowlist rule not found | — |
503 | API under maintenance | — |
PATCH/v1/ip-allowlist/{ip_allowlist_rule_id}Update an IP allowlist rule
Parameters
| Name | In | Required | Type |
|---|---|---|---|
ip_allowlist_rule_id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The IP allowlist rule was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
DELETE/v1/ip-allowlist/{ip_allowlist_rule_id}Delete an IP allowlist rule
Parameters
| Name | In | Required | Type |
|---|---|---|---|
ip_allowlist_rule_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The IP allowlist rule was deleted successfully. | — |
401 | Invalid API key | — |
403 | Forbidden Call | — |
404 | Label not found | — |
503 | API under maintenance | — |
IPs1
Get GitGuardian's IP addresses for IP allowlisting. Use this endpoint to retrieve GitGuardian's egress IP addresses in CIDR notation. Allowlist these IPs in your firewalls, network security groups, or other access control systems to enable GitGuardian services to access your resources.
GET/v1/ipsList GitGuardian IP addresses
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successfully returned IP addresses (or empty list if not configured) | — |
SCIM Users6
System for Cross-domain Identity Management (SCIM) is a standard for automating the exchange of user identity information between identity domains, or IT systems.
GET/v1/scim/v2/UsersList members (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
filter | query | no | string |
startIndex | query | no | integer |
count | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member List | — |
400 | Bad Request | — |
403 | Forbidden | — |
POST/v1/scim/v2/UsersCreate a member (SCIM)
Request body
application/scim+json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Member Created | — |
400 | Bad Request | — |
403 | Forbidden | — |
409 | Conflict | — |
GET/v1/scim/v2/Users/{id}Detail of a member (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member Detail | — |
403 | Forbidden | — |
404 | Not Found | — |
PUT/v1/scim/v2/Users/{id}Update of a member (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/scim+json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member Detail | — |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Bad Request | — |
PATCH/v1/scim/v2/Users/{id}Update (partial) of a member (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/scim+json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Member Detail | — |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Bad Request | — |
DELETE/v1/scim/v2/Users/{id}Delete a member (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | No Content | — |
400 | Bad Request | — |
404 | Not Found | — |
SCIM Groups6
System for Cross-domain Identity Management (SCIM) is a standard for automating the exchange of group identity information between identity domains, or IT systems.
GET/v1/scim/v2/GroupsList groups (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
filter | query | no | string |
startIndex | query | no | integer |
count | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | A list of groups | — |
400 | Bad Request | — |
403 | Forbidden | — |
POST/v1/scim/v2/GroupsCreate a group (SCIM)
Request body
application/scim+json
Responses
| Status | Description | Schema |
|---|---|---|
201 | Group Created | — |
400 | Bad Request | — |
403 | Forbidden | — |
409 | Conflict | — |
GET/v1/scim/v2/Groups/{id}Detail of a group (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Group Detail | — |
403 | Forbidden | — |
404 | Not Found | — |
PUT/v1/scim/v2/Groups/{id}Update a group (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/scim+json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Group Detail | — |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Bad Request | — |
PATCH/v1/scim/v2/Groups/{id}Partially update a group (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Request body
application/scim+json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Group Detail | — |
400 | Bad Request | — |
403 | Forbidden | — |
404 | Bad Request | — |
DELETE/v1/scim/v2/Groups/{id}Delete a group (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | No Content | — |
400 | Bad Request | — |
404 | Not Found | — |
SCIM Metadata5
System for Cross-domain Identity Management (SCIM) is a standard for automating the exchange of user identity information between identity domains, or IT systems.
GET/v1/scim/v2/ResourceTypesList Resource Types (SCIM)
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of Resource Types | — |
403 | Forbidden | — |
GET/v1/scim/v2/ResourceTypes/{name}Resource Types (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
name | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Resource Type (SCIM) | — |
403 | Forbidden | — |
404 | Not Found | — |
GET/v1/scim/v2/SchemasList Schemas (SCIM)
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of SCIM Schemas | — |
403 | Forbidden | — |
GET/v1/scim/v2/Schemas/{name}Schema (SCIM)
Parameters
| Name | In | Required | Type |
|---|---|---|---|
name | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | SCIM Schema | — |
403 | Forbidden | — |
404 | Not Found | — |
GET/v1/scim/v2/ServiceProviderConfigService Provider Configuration (SCIM)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Service Provider Configuration (SCIM) | — |
403 | Forbidden | — |
Custom Tags8
Manage custom tags. Linking a custom tag to resources occurs at the resource endpoints themselves. For example, you can apply a custom tag to an incident [here](#tag/Secret-Incidents/operation/update-secret-incident) or to a honeytoken [here](#tag/Honeytokens/operation/update-honeytoken).
GET/v1/custom_tagsList custom tags
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
key | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Custom tags list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
POST/v1/custom_tagsCreate a custom tag
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
201 | The custom tag was created successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
PATCH/v1/custom_tagsUpdate custom tags key
Parameters
| Name | In | Required | Type |
|---|---|---|---|
old_key | query | yes | string |
new_key | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Custom tags updated with the new key | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
DELETE/v1/custom_tagsDelete a custom tags key
Parameters
| Name | In | Required | Type |
|---|---|---|---|
key | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Custom tags using the given key were successfully deleted | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
GET/v1/custom_tags/{custom_tag_id}Retrieve a custom tag
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_tag_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Custom tag was found successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
PUT/v1/custom_tags/{custom_tag_id}Full Update of a Custom Tag
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_tag_id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Custom tag was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
PATCH/v1/custom_tags/{custom_tag_id}Partial update of a Custom Tag
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_tag_id | path | yes | string |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Custom tag was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
DELETE/v1/custom_tags/{custom_tag_id}Deletion of a custom tag
Parameters
| Name | In | Required | Type |
|---|---|---|---|
custom_tag_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Custom tag was deleted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
Developer1
Retrieve developers from the public perimeter.
GET/v1/public-perimeter/developersList developers
Parameters
| Name | In | Required | Type |
|---|---|---|---|
search | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Developers List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
OAuth25
OAuth 2.0 / OpenID Connect endpoints used to integrate third-party clients (such as MCP clients) with GitGuardian. The supported flow is **Authorization Code + PKCE** ([RFC 7636](https://www.rfc-editor.org/rfc/rfc7636)). The authorization endpoint itself is served by the GitGuardian dashboard; this group documents the API-side endpoints: - **[Token endpoint](#operation/public-oauth-token)** — exchanges an authorization code for a personal access token ([RFC 6749](https://www.rfc-editor.org/rfc/rfc6749)). - **[Dynamic Client Registration](#operation/public-oauth-register)** — lets clients register themselves ([RFC 7591](https://www.rfc-editor.org/rfc/rfc7591)). - **[Authorization Server Metadata](#operation/public-oauth-authorization-server-metadata)** — discovery document ([RFC 8414](https://www.rfc-editor.org/rfc/rfc8414)). - **[OpenID Connect Discovery](#operation/public-oidc-well-known-configuration)** — OIDC discovery document. - **[JWKS](#operation/public-jwks)** — public keys used to validate issued JWTs ([RFC 7517](https://www.rfc-editor.org/rfc/rfc7517)).
GET/.well-known/oauth-authorization-serverOAuth 2.0 Authorization Server Metadata.
Responses
| Status | Description | Schema |
|---|---|---|
200 | Authorization server metadata document. | — |
GET/.well-known/openid-configurationOpenID Connect discovery document.
Responses
| Status | Description | Schema |
|---|---|---|
200 | OIDC discovery document. | — |
GET/v1/auth/jwksList public keys used to sign JWTs.
Responses
| Status | Description | Schema |
|---|---|---|
200 | JSON Web Key Set. | — |
500 | No signing keys are configured on this instance. | — |
POST/v1/oauth/registerDynamically register an OAuth 2.0 client.
Request body
application/json (required)
Responses
| Status | Description | Schema |
|---|---|---|
201 | Client successfully registered. ([RFC 7591 §3.2.1](https://www.rfc-editor.org/rfc/rfc7591#section-3.2.1)) | — |
400 | Invalid client metadata. ([RFC 7591 §3.2.2](https://www.rfc-editor.org/rfc/rfc7591#section-3.2.2)) | — |
404 | Dynamic Client Registration is disabled for this workspace. | — |
429 | Rate limit exceeded. The registration endpoint is throttled to prevent abuse. | — |
POST/v1/oauth/tokenExchange an authorization code for an access token.
Request body
application/x-www-form-urlencoded (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | Token successfully issued. | — |
400 | OAuth 2.0 error response ([RFC 6749 §5.2](https://www.rfc-editor.org/rfc/rfc6749#section-5.2)). Returned for example when the authorization code is invalid, expired, the PKCE verifier does not match, or the request is otherwise malformed. | — |
401 | OAuth 2.0 error response when client authentication fails (unknown `client_id` or invalid `client_secret`). | — |
Audit Logs2
GET/v1/audit_logsList audit Logs
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
event_name | query | no | string |
member_id | query | no | integer |
member_name | query | no | string |
member_email | query | no | string |
api_token_id | query | no | string |
ip_address | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Audit logs List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/audit_logs/event_namesList audit log event names
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of audit log event names | — |
401 | Invalid API key | — |
403 | Forbidden | — |
Honeytoken Activity Logs1
GET/v1/honeytokens/{honeytoken_id}/activity-logsList activity logs of a honeytoken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
honeytoken_id | path | yes | string |
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
member_id | query | no | integer |
api_token_id | query | no | string |
content_key | query | no | string |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Honeytoken Activity Log List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Honeytoken not found | — |
503 | API under maintenance | — |
Internal Secret Incident Activity Logs1
GET/v1/incidents/secrets/{incident_id}/activity-logsList activity logs of a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
member_id | query | no | integer |
api_token_id | query | no | string |
content_key | query | no | string |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Incident Activity Log List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
Internal Secret Incident Notes4
GET/v1/incidents/secrets/{incident_id}/notesList notes on a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
ordering | query | no | string |
member_id | query | no | integer |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Incident Note List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/notesCreate a secret incident note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | The note was created successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Secret Incident not found. | — |
503 | API under maintenance | — |
PATCH/v1/incidents/secrets/{incident_id}/notes/{note_id}Update a secret incident note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
note_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The note was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | You cannot update an Incident Note you that was not created by the current API key. | — |
404 | Secret Incident or Incident Note not found. | — |
503 | API under maintenance | — |
DELETE/v1/incidents/secrets/{incident_id}/notes/{note_id}Delete a secret incident note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
note_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The note was deleted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | You cannot delete an Incident Note you that was not created by the current API key. | — |
404 | Secret Incident or Incident Note not found. | — |
503 | API under maintenance | — |
Internal Secret Incidents25
GET/v1/incidents/secretsList secret incidents
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
triggered_at_before | query | no | string |
triggered_at_after | query | no | string |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
exclude_tags | query | no | string |
custom_tags | query | no | string |
custom_tag_key | query | no | string |
custom_tag_value | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
feedback | query | no | boolean |
only_on_provider_archived_sources | query | no | boolean |
risk_score_min | query | no | integer |
risk_score_max | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}Retrieve a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
with_occurrences | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
PATCH/v1/incidents/secrets/{incident_id}Update a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details without occurrences. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/assignAssign a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details without occurrences. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/grant_accessGrant access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
204 | The access was granted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/ignoreIgnore a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details without occurrences. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}/impacted_perimeterRetrieve the impacted perimeter of a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Impacted Perimeter | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}/invitationsList invitations having access to a Secret Incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
invitation_id | query | no | number |
incident_permission | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of invitation accesses | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}/leaksRetrieve where a secret has been publicly leaked
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of the leaks of the incident | — |
401 | Invalid API key | — |
404 | Incident not found | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}/membersList members having access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
member_id | query | no | number |
incident_permission | query | no | string |
role | query | no | — |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of members | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/reopenReopen a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details without occurrences. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/resolveResolve a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details without occurrences. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/revoke_accessRevoke access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
204 | The access was revoked successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/shareShare a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Incident Sharing Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}/teamsList teams having access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
team_id | query | no | number |
incident_permission | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List of team accesses | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/unassignUnassign a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident Details without occurrences. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/incidents/secrets/{incident_id}/unshareUnshare a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The public link was revoked successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/incidents/secrets/{incident_id}/vaultsGet vault information for a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Vault information for the secret incident | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
GET/v1/remediation-workflowRetrieve the remediation workflow
Responses
| Status | Description | Schema |
|---|---|---|
200 | Remediation Workflow | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/secret-incidents/{incident_id}/invitationsList invitations with access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
search | query | no | string |
ordering | query | no | string |
direct_access | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List invitations | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
GET/v1/secret-incidents/{incident_id}/membersList members with access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
role | query | no | — |
access_level | query | no | — |
search | query | no | string |
ordering | query | no | string |
direct_access | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List members | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
GET/v1/secret-incidents/{incident_id}/teamsList teams with access to a secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
search | query | no | string |
direct_access | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List teams | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Secret Incident not found | — |
503 | API under maintenance | — |
GET/v1/secrets/{secret_id}Retrieve a secret value
Parameters
| Name | In | Required | Type |
|---|---|---|---|
secret_id | path | yes | integer |
X-Privacy-Mode | header | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Secret not found | — |
503 | API under maintenance | — |
GET/v1/sources/{source_id}/incidents/secretsList secret incidents of a source
Parameters
| Name | In | Required | Type |
|---|---|---|---|
source_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
custom_tags | query | no | string |
custom_tag_key | query | no | string |
custom_tag_value | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
feedback | query | no | boolean |
only_on_provider_archived_sources | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/teams/{team_id}/incidents/secretsList secret incidents of a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
team_id | path | yes | integer |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
custom_tags | query | no | string |
custom_tag_key | query | no | string |
custom_tag_value | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
only_on_provider_archived_sources | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Internal Secret Occurrences1
GET/v1/occurrences/secretsList secret occurrences
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
page | query | no | integer |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
source_id | query | no | integer |
source_name | query | no | string |
source_type | query | no | string |
source_monitoring_status | query | no | string |
incident_id | query | no | integer |
incident_assignee_id | query | no | integer |
presence | query | no | — |
author_name | query | no | string |
author_info | query | no | string |
sha | query | no | string |
filepath | query | no | string |
severity | query | no | — |
status | query | no | — |
validity | query | no | — |
tags | query | no | string |
exclude_tags | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List occurrences | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Public Secret Incident Activity Logs1
GET/v1/public-incidents/secrets/{incident_id}/activity-logsList activity logs of a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
member_id | query | no | integer |
api_token_id | query | no | string |
content_key | query | no | string |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Incident Activity Log List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Public Secret Incident not found | — |
503 | API under maintenance | — |
Public Secret Incident Notes4
GET/v1/public-incidents/secrets/{incident_id}/notesList notes on a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
ordering | query | no | string |
member_id | query | no | integer |
search | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Incident Note List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Public Secret Incident not found | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/notesCreate a public secret incident note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
201 | The note was created successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
404 | Public Secret Incident not found. | — |
503 | API under maintenance | — |
PATCH/v1/public-incidents/secrets/{incident_id}/notes/{note_id}Update a public secret incident note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
note_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | The note was updated successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | You cannot update an Incident Note you that was not created by the current API key. | — |
404 | Public Secret Incident or Incident Note not found. | — |
503 | API under maintenance | — |
DELETE/v1/public-incidents/secrets/{incident_id}/notes/{note_id}Delete a public secret incident note
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
note_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | The note was deleted successfully. | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | You cannot delete an Incident Note you that was not created by the current API key. | — |
404 | Public Secret Incident or Incident Note not found. | — |
503 | API under maintenance | — |
Public Secret Incidents12
GET/v1/public-incidents/secretsList public secret incidents
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Privacy-Mode | header | no | string |
cursor | query | no | string |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
triggered_at_before | query | no | string |
triggered_at_after | query | no | string |
assignee_email | query | no | string |
assignee_id | query | no | integer |
status | query | no | — |
severity | query | no | — |
validity | query | no | — |
tags | query | no | string |
custom_tags | query | no | string |
custom_tag_key | query | no | string |
custom_tag_value | query | no | string |
ordering | query | no | string |
detector_group_name | query | no | string |
ignorer_id | query | no | integer |
ignorer_api_token_id | query | no | string |
resolver_id | query | no | integer |
resolver_api_token_id | query | no | string |
feedback | query | no | boolean |
declarative_secret_status | query | no | — |
risk_score_min | query | no | integer |
risk_score_max | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident List | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/public-incidents/secrets/{incident_id}Retrieve a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Privacy-Mode | header | no | string |
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/assignAssign a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/ignoreIgnore a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/reopenReopen a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/resolveResolve a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/set_custom_tagsSet custom tags of a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/set_severitySet severity of a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/shareShare a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Issue Token Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/unassignUnassign a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Incident Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
POST/v1/public-incidents/secrets/{incident_id}/unshareUnshare a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Share link deleted successfully | — |
400 | Invalid data | — |
401 | Invalid API key | — |
409 | Data conflict | — |
503 | API under maintenance | — |
GET/v1/public-incidents/secrets/{incident_id}/vaultsGet vault information for a public secret incident
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Vault information for the public secret incident | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
Public Secret Occurrences2
GET/v1/public-incidents/secrets/{incident_id}/occurrencesList public secret occurrences
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
cursor | query | no | string |
per_page | query | no | integer |
date_before | query | no | string |
date_after | query | no | string |
source_id | query | no | integer |
presence | query | no | — |
sha | query | no | string |
filepath | query | no | string |
attachment_reason | query | no | string |
severity | query | no | — |
status | query | no | — |
validity | query | no | — |
tags | query | no | string |
ordering | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | List public secret occurrences | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
GET/v1/public-incidents/secrets/{incident_id}/occurrences/{occurrence_id}Retrieve a public secret occurrence
Parameters
| Name | In | Required | Type |
|---|---|---|---|
incident_id | path | yes | integer |
occurrence_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Public Secret Occurrence Details | — |
400 | Invalid data | — |
401 | Invalid API key | — |
503 | API under maintenance | — |
Scans1
GET/v1/scans/{scan_id}/auditGet a scan's audit summary
Parameters
| Name | In | Required | Type |
|---|---|---|---|
scan_id | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Scan Audit Summary | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Forbidden | — |
404 | Resource not found | — |
503 | API under maintenance | — |
Team Requests5
GET/v1/members/{member_id}/team_requestsList team requests of a member
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
member_id | path | yes | integer |
team_id | query | no | number |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team request list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
GET/v1/teams/{team_id}/team_requestsList team requests of a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
team_id | path | yes | integer |
member_id | query | no | number |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team request list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
POST/v1/teams/{team_id}/team_requestsRequest access to a team
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
201 | Team request created | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
409 | Data conflict | — |
503 | API under maintenance | — |
DELETE/v1/teams/{team_id}/team_requests/{team_request_id}Cancel or decline a team request
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
team_request_id | path | yes | integer |
send_email | query | no | boolean |
Responses
| Status | Description | Schema |
|---|---|---|
204 | Team request deleted | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
POST/v1/teams/{team_id}/team_requests/{team_request_id}/acceptAccept a team request
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
team_request_id | path | yes | integer |
send_email | query | no | boolean |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
200 | Team request accepted | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
Team Sources2
GET/v1/teams/{team_id}/sourcesList team sources
Parameters
| Name | In | Required | Type |
|---|---|---|---|
cursor | query | no | string |
per_page | query | no | integer |
team_id | path | yes | integer |
search | query | no | string |
last_scan_status | query | no | — |
health | query | no | — |
type | query | no | — |
ordering | query | no | string |
visibility | query | no | string |
external_id | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Source list | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
POST/v1/teams/{team_id}/sourcesUpdate a team perimeter
Parameters
| Name | In | Required | Type |
|---|---|---|---|
team_id | path | yes | integer |
Request body
application/json
Responses
| Status | Description | Schema |
|---|---|---|
204 | Team perimeter updated | — |
400 | Invalid data | — |
401 | Invalid API key | — |
403 | Permission denied | — |
404 | Not found | — |
503 | API under maintenance | — |
Try it
Developer reference
Base URL
https://api.gitguardian.comRate limit
PAT: Free 50 req/min, Business 200 req/min, Enterprise 2000 req/min; Service Account: Business 1000 req/min, Enterprise 10000 req/min
Key endpoints
- GET/v1/health
- GET/v1/quotas
- GET/v1/incidents/secrets
- GET/v1/sources
SDKs
Changelog
Spec version1.1.0
Tracked paths131
- gained an OpenAPI spec and official SDKs