curl --request GET \
--url https://patch.gg/api/v1/projects/{owner}/{slug}/repo/history-scan \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/repo/history-scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://patch.gg/api/v1/projects/{owner}/{slug}/repo/history-scan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"up_to_date": true,
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"head_commit": "<string>",
"failure": "<string>",
"secret_count": 1,
"secrets": [
{
"commit": "<string>",
"path": "<string>",
"line": 2,
"rule": "an AWS access key",
"masked": "AKIA…",
"in": "file"
}
],
"removable_tags": [
"<string>"
],
"live_tags": [
"<string>"
],
"fix": [
{
"step": "<string>",
"commands": [
"<string>"
]
}
],
"will_become_public": {
"commit_count": 1,
"branches": {
"count": 1,
"names": [
"<string>"
]
},
"tags": {
"count": 1,
"names": [
"<string>"
]
},
"other_refs": {
"count": 1,
"names": [
"<string>"
]
},
"files_at_head": {
"count": 1,
"paths": [
"<string>"
]
},
"big_files": {
"count": 1,
"total_size": 1,
"scanned": true,
"files": [
{
"path": "<string>",
"sha256": "<string>",
"size": 1,
"not_read": "too_big"
}
],
"not_read": {
"count": 1,
"total_size": 1
},
"coverage": "<string>"
},
"authors": {
"count": 1,
"people": [
{
"name": "<string>",
"email": "<string>",
"commits": 1
}
]
}
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}A repo's latest history scan
Members of the owning org. Each secret says its commit, path, line and rule, with the secret itself masked. Patch never stores or returns its value. will_become_public is what going open publishes, every author’s email included. up_to_date is false once a push has landed since it started. With wait, it holds the answer while the scan runs, until it finishes (up to 50 seconds).
curl --request GET \
--url https://patch.gg/api/v1/projects/{owner}/{slug}/repo/history-scan \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://patch.gg/api/v1/projects/{owner}/{slug}/repo/history-scan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://patch.gg/api/v1/projects/{owner}/{slug}/repo/history-scan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"up_to_date": true,
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"head_commit": "<string>",
"failure": "<string>",
"secret_count": 1,
"secrets": [
{
"commit": "<string>",
"path": "<string>",
"line": 2,
"rule": "an AWS access key",
"masked": "AKIA…",
"in": "file"
}
],
"removable_tags": [
"<string>"
],
"live_tags": [
"<string>"
],
"fix": [
{
"step": "<string>",
"commands": [
"<string>"
]
}
],
"will_become_public": {
"commit_count": 1,
"branches": {
"count": 1,
"names": [
"<string>"
]
},
"tags": {
"count": 1,
"names": [
"<string>"
]
},
"other_refs": {
"count": 1,
"names": [
"<string>"
]
},
"files_at_head": {
"count": 1,
"paths": [
"<string>"
]
},
"big_files": {
"count": 1,
"total_size": 1,
"scanned": true,
"files": [
{
"path": "<string>",
"sha256": "<string>",
"size": 1,
"not_read": "too_big"
}
],
"not_read": {
"count": 1,
"total_size": 1
},
"coverage": "<string>"
},
"authors": {
"count": 1,
"people": [
{
"name": "<string>",
"email": "<string>",
"commits": 1
}
]
}
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "version_exists",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
An API key (pch_...) or the token from pch login.
Query Parameters
Seconds (up to 50) to wait for this to change while Patch is working on it. Answers at once when it's your turn or the person's.
0 <= x <= 50Response
The scan
running, clean, secrets_found, failed False once a push has landed since it started, which means a new scan.
The default branch's commit, as the scan read it.
Why a failed scan didn't finish.
x >= 0The first of them, oldest commit first.
Show child attributes
Show child attributes
With secrets found: tags of releases that never went live and hold them. A push may delete these, with plain git, and those releases can't go out after that.
With secrets found: tags of releases that went live and hold them. What's live never changes, so these can't come out, and the repo's code can only stay closed.
With secrets found: how to take them out of the history.
Show child attributes
Show child attributes
What going open publishes, once a scan has read it.
Show child attributes
Show child attributes