Skip to main content

​
Get public secret incident

Action ID: tools.gitguardian.get_public_secret_incident Get a public secret incident. Calls GET /v1/public-incidents/secrets/{incident_id} directly. Reference: https://api.gitguardian.com/docs#tag/Public-Secret-Incidents/operation/getPublicIncident

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
integer
required
The id of the incident to retrieve.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
string | null
When set to true, sensitive values in the response are obfuscated (replaced with <GG>OBFUSCATED</GG>). Useful for sharing API responses without exposing sensitive data. Possible values: true, false.Default: null.

​
Get secret incident

Action ID: tools.gitguardian.get_secret_incident Get a secret incident. Calls GET /v1/incidents/secrets/{incident_id} directly. Reference: https://api.gitguardian.com/docs#tag/Internal-Secret-Incidents/operation/getIncident

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
integer
required
The id of the incident to retrieve.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
integer | null
Retrieve a number of occurrences of this incident.Default: null.

​
List public secret incidents

Action ID: tools.gitguardian.list_public_secret_incidents List public secret incidents. Calls GET /v1/public-incidents/secrets directly. Reference: https://api.gitguardian.com/docs#tag/Public-Secret-Incidents/operation/listPublicIncidents

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
string | null
Public secret incidents assigned to this email.Default: null.
​
integer | null
Public secret incidents assigned to this user id.Default: null.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
string | null
Pagination cursor.Default: null.
​
string | null
Public secret incidents with the given custom tag key.Default: null.
​
string | null
Public secret incidents with the given custom tag value.Default: null.
​
string | null
Public secret incidents with one of the following custom tag ids. To retrieve incidents containing several custom tags at once, this query parameter should be used several times to intersect the results.Default: null.
​
string | null
Entries found after this date.Default: null.
​
string | null
Entries found before this date.Default: null.
​
string | null
Public secret incidents with the following declarative secret status. Possible values: revoked, active, test_credential, false_positive, low_risk.Default: null.
​
string | null
Public secret incidents belonging to the specified detector group.Default: null.
​
boolean | null
Public secret incidents with or without feedback.Default: null.
​
string | null
Public secret incidents ignored by this API token id.Default: null.
​
integer | null
Public secret incidents ignored by this user id.Default: null.
​
string | null
Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a ’-’. Possible values: date, -date, resolved_at, -resolved_at, ignored_at, -ignored_at, risk_score, -risk_score.Default: null.
​
integer | null
Number of items to list per page.Default: null.
​
string | null
When set to true, sensitive values in the response are obfuscated (replaced with <GG>OBFUSCATED</GG>). Useful for sharing API responses without exposing sensitive data. Possible values: true, false.Default: null.
​
string | null
Public secret incidents resolved by this API token id.Default: null.
​
integer | null
Public secret incidents resolved by this user id.Default: null.
​
integer | null
Incidents with risk score lesser than value.Default: null.
​
integer | null
Incidents with risk score greater than value.Default: null.
​
string | null
Filter public secret incidents by severity. Possible values: critical, high, medium, low, info, unknown.Default: null.
​
string | null
Public secret incidents with the following status. Possible values: IGNORED, TRIGGERED, ASSIGNED, RESOLVED.Default: null.
​
string | null
Public secret incidents with one of the following tags. Use NONE if you want to filter incidents with no tags.Default: null.
​
string | null
Incidents with triggered_at after this date.Default: null.
​
string | null
Incidents with triggered_at before this date.Default: null.
​
string | null
Public secret incident with the following validity. Possible values: valid, invalid, failed_to_check, no_checker, unknown.Default: null.

​
List public secret occurrences

Action ID: tools.gitguardian.list_public_secret_occurrences List public secret occurrences. Calls GET /v1/public-incidents/secrets/{incident_id}/occurrences directly. Reference: https://api.gitguardian.com/docs#tag/Public-Secret-Occurrences/operation/listPublicOccurrences

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
integer
required
The id of the incident to retrieve.
​
string | null
Occurrences with one of the following attachment reasons. Possible values: by_dev_from_perimeter, on_github_org_in_perimeter, from_secret_grasper.Default: null.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
string | null
Pagination cursor.Default: null.
​
string | null
Entries found after this date.Default: null.
​
string | null
Entries found before this date.Default: null.
​
string | null
Entries matching this filepath search.Default: null.
​
string | null
Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a ’-’. Possible values: id, -id, date, -date.Default: null.
​
integer | null
Number of items to list per page.Default: null.
​
string | null
Entries that have the following presence status. Possible values: present, removed, unknown.Default: null.
​
string | null
Filter occurrences by the severity of their related incident. Can specify multiple values separated by commas. Possible values: critical, high, medium, low, info, unknown.Default: null.
​
string | null
Entries starting with the commit sha search string.Default: null.
​
integer | null
Filter on the source ID.Default: null.
​
string | null
Filter occurrences by the status of their related incident. Can specify multiple values separated by commas. Possible values: IGNORED, TRIGGERED, ASSIGNED, RESOLVED.Default: null.
​
string | null
Public secret incidents with one of the following tags. Use NONE if you want to filter incidents with no tags.Default: null.
​
string | null
Filter occurrences by the validity of their related secret. Can specify multiple values separated by commas. Possible values: valid, invalid, failed_to_check, no_checker, unknown.Default: null.

​
List secret incidents

Action ID: tools.gitguardian.list_secret_incidents List secret incidents. Calls GET /v1/incidents/secrets directly. Reference: https://api.gitguardian.com/docs#tag/Internal-Secret-Incidents/operation/listIncidents

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
string | null
Incidents assigned to this email.Default: null.
​
integer | null
Incidents assigned to this user id.Default: null.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
string | null
Pagination cursor.Default: null.
​
string | null
Incidents with the given custom tag key.Default: null.
​
string | null
Incidents with the given custom tag value.Default: null.
​
string | null
Incidents with one of the following custom tag ids. To retrieve incidents containing several custom tags at once, this query parameter should be used several times to intersect the results.Default: null.
​
string | null
Entries found after this date.Default: null.
​
string | null
Entries found before this date.Default: null.
​
string | null
Incidents belonging to the specified detector group.Default: null.
​
string | null
Exclude incidents with any of the following tags (comma-separated). Use NONE to exclude incidents with no tags.Default: null.
​
boolean | null
Incidents with or without feedback.Default: null.
​
string | null
Incidents ignored by this API token id.Default: null.
​
integer | null
Incidents ignored by this user id.Default: null.
​
boolean | null
When true, only return secret incidents where every detection is on a source archived on the provider (same meaning as provider_metadata.archived on the Sources API). Source types that do not support an archived flag are never considered archived.Default: null.
​
string | null
Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a ’-’. Possible values: date, -date, resolved_at, -resolved_at, ignored_at, -ignored_at, risk_score, -risk_score.Default: null.
​
integer | null
Page number.Default: null.
​
integer | null
Number of items to list per page.Default: null.
​
string | null
Incidents resolved by this API token id.Default: null.
​
integer | null
Incidents resolved by this user id.Default: null.
​
integer | null
Incidents with risk score lesser than value.Default: null.
​
integer | null
Incidents with risk score greater than value.Default: null.
​
string | null
Filter incidents by severity. Possible values: critical, high, medium, low, info, unknown.Default: null.
​
string | null
Incidents with the following status. Possible values: IGNORED, TRIGGERED, ASSIGNED, RESOLVED.Default: null.
​
string | null
Incidents with one of the following tags. Use NONE if you want to filter incidents with no tags.Default: null.
​
string | null
Incidents with triggered_at after this date.Default: null.
​
string | null
Incidents with triggered_at before this date.Default: null.
​
string | null
Secrets with the following validity. Possible values: valid, invalid, failed_to_check, no_checker, unknown.Default: null.

​
List secret occurrences

Action ID: tools.gitguardian.list_secret_occurrences List secret occurrences. Calls GET /v1/occurrences/secrets directly. Reference: https://api.gitguardian.com/docs#tag/Internal-Secret-Occurrences/operation/listOccurrences

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
string | null
Entries matching this author email search.Default: null.
​
string | null
Entries matching this author name search.Default: null.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
string | null
Pagination cursor.Default: null.
​
string | null
Entries found after this date.Default: null.
​
string | null
Entries found before this date.Default: null.
​
string | null
Exclude occurrences with any of the following tags (comma-separated). Use NONE to exclude occurrences with no tags.Default: null.
​
string | null
Entries matching this filepath search.Default: null.
​
integer | null
Filter by incident assignee member ID.Default: null.
​
integer | null
Filter by incident ID.Default: null.
​
string | null
Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a ’-’. Possible values: date, -date.Default: null.
​
integer | null
Page number.Default: null.
​
integer | null
Number of items to list per page.Default: null.
​
string | null
Entries that have the following presence status. Possible values: present, removed.Default: null.
​
string | null
Filter occurrences by the severity of their related incident. Can specify multiple values separated by commas. Possible values: critical, high, medium, low, info, unknown.Default: null.
​
string | null
Entries starting with the commit sha search string.Default: null.
​
integer | null
Filter on the source ID.Default: null.
​
string | null
Keep only occurrences whose source’s real-time monitoring status is one of the given (comma-separated) buckets. Requires the monitoring-status feature to be enabled for the workspace; otherwise the parameter is ignored.Default: null.
​
string | null
Entries matching this source name search.Default: null.
​
string | null
Filter by source type. Possible values: bitbucket, bitbucket_cloud, github, gitlab, azure_devops, slack, jira_cloud, confluence_cloud, microsoft_teams, confluence_data_center, jira_data_center, aws_ecr, azure_cr, google_artifact, jfrog_artifact, docker_hub, servicenow, sharepoint_online, sharepoint_online_drive, sharepoint_online_pages, microsoft_onedrive, custom_source.Default: null.
​
string | null
Filter occurrences by the status of their related incident. Can specify multiple values separated by commas. Possible values: IGNORED, TRIGGERED, ASSIGNED, RESOLVED.Default: null.
​
string | null
Occurrences with one of the following tags. Use NONE if you want to filter occurrences with no tags.Default: null.
​
string | null
Filter occurrences by the validity of their related secret. Can specify multiple values separated by commas. Possible values: valid, invalid, failed_to_check, no_checker, unknown.Default: null.

​
Scan content

Action ID: tools.gitguardian.scan_content Scan content. Calls POST /v1/scan directly with one document. Reference: https://api.gitguardian.com/docs#tag/Scan-Methods/operation/scan

​
Secrets

Required secrets:
  • gitguardian: required values GITGUARDIAN_API_KEY.

​
Input fields

​
string
required
Document content to scan. Request body shouldn’t exceed 1MB.
​
string | null
Base URL of the GitGuardian API.Default: null.
​
string | null
Filename associated with the document, for example .env. Maximum length is 256 characters.Default: null.