Add context to a pentest finding
curl --request PUT \
--url https://api.trycomp.ai/v1/pentest-finding-contexts/{issueId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"runId": "pentest-abc123",
"context": "Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users."
}
'const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
runId: 'pentest-abc123',
context: 'Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users.'
})
};
fetch('https://api.trycomp.ai/v1/pentest-finding-contexts/{issueId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/pentest-finding-contexts/{issueId}"
payload = {
"runId": "pentest-abc123",
"context": "Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users."
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)Security Penetration Tests
Add context to a pentest finding | Comp AI API
Saves a customer context note on a pentest finding, e.g. an accepted-by-design rationale or remediation details. Future scans of the same target pass the.
PUT
/
v1
/
pentest-finding-contexts
/
{issueId}
Add context to a pentest finding
curl --request PUT \
--url https://api.trycomp.ai/v1/pentest-finding-contexts/{issueId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"runId": "pentest-abc123",
"context": "Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users."
}
'const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
runId: 'pentest-abc123',
context: 'Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users.'
})
};
fetch('https://api.trycomp.ai/v1/pentest-finding-contexts/{issueId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/pentest-finding-contexts/{issueId}"
payload = {
"runId": "pentest-abc123",
"context": "Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users."
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)Authorizations
API key for authentication
Headers
Organization ID (required for session auth, optional for API key auth)
Path Parameters
Body
application/json
Penetration test run ID the finding belongs to
Example:
"pentest-abc123"
Context for the finding, e.g. an accepted-by-design rationale or remediation details. Shared with the testing agent on future scans of the same target. Max 2000 characters.
Maximum string length:
2000Example:
"Read access to appConfiguration is accepted by design: the collection only holds non-secret bootstrap configuration and write access is restricted to privileged users."
Response
Context note saved
Was this page helpful?