Get penetration test progress
curl --request GET \
--url https://api.trycomp.ai/v1/security-penetration-tests/{id}/progress \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.trycomp.ai/v1/security-penetration-tests/{id}/progress', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/security-penetration-tests/{id}/progress"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"status": "provisioning",
"completedAgents": 123,
"totalAgents": 123,
"elapsedMs": 123,
"reconcileHealth": "ok"
}Security Penetration Tests
Get penetration test progress | Comp AI API
Returns progress for a run, including reconcileHealth (ok, retrying, stalled) so clients can tell an interrupted scan from a live one.
GET
/
v1
/
security-penetration-tests
/
{id}
/
progress
Get penetration test progress
curl --request GET \
--url https://api.trycomp.ai/v1/security-penetration-tests/{id}/progress \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.trycomp.ai/v1/security-penetration-tests/{id}/progress', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/security-penetration-tests/{id}/progress"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"status": "provisioning",
"completedAgents": 123,
"totalAgents": 123,
"elapsedMs": 123,
"reconcileHealth": "ok"
}Authorizations
API key for authentication
Headers
Organization ID (required for session auth, optional for API key auth)
Path Parameters
Response
200 - application/json
Progress returned
Current lifecycle status of the run
Available options:
provisioning, cloning, running, completed, failed, cancelled Agents that have finished
Total agents in the scan
Milliseconds elapsed since the scan started
Health of our supervision of an in-flight scan. "retrying": the scan was interrupted and status checks keep failing. "stalled": that has persisted with no scan activity, so the scan is likely dead. Absent for providers that do not report it.
Available options:
ok, retrying, stalled Was this page helpful?

