Internal Secret Incidents
Retrieve the impacted perimeter of a secret incident
Retrieve metrics about the impacted perimeter of a secret incident detected by the GitGuardian dashboard.
get/v1/incidents/secrets/{incident_id}/impacted_perimeter
Path parameters
incident_idinteger required
The id of the incident to retrieve
Response
Secret Incident Impacted Perimeter
Example response
{
"id": 1,
"secret_presence": {
"files_requiring_code_fix": 1,
"files_pending_merge": 1,
"files_fixed": 1,
"outside_vcs": 1,
"in_vcs": 3
},
"sources": [
{
"id": 1,
"url": "https://github.com/GitGuardian/ggshield/",
"type": "gh_repository",
"full_name": "GitGuardian/ggshield",
"files": {
"files_requiring_code_fix": [
{
"filepath": "foo.txt",
"mentions_count": 1,
"file_url": "https://github.com/GitGuardian/ggshield/blob/main/foo.txt"
}
],
"files_pending_merge": [
{
"filepath": "bar.txt",
"mentions_count": 1,
"file_url": "https://github.com/GitGuardian/ggshield/blob/main/bar.txt"
}
],
"files_fixed": [
{
"filepath": "baz.txt",
"mentions_count": 1,
"merge_request_url": "https://github.com/GitGuardian/ggshield/pull/123"
}
]
}
}
]
}