Read an existing security scan
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"scan": {
"status": "pending",
"failure": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"scanId": "<string>",
"directoryRetryable": true,
"directoryRetryRepoId": "<string>"
},
"hasPreviousResults": true,
"scanMode": "<string>",
"isPartial": true,
"deferredReason": "<string>",
"counts": {
"total": 123,
"critical": 123,
"high": 123,
"medium": 123,
"low": 123,
"verifiedActive": 123
},
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"investigation": {
"expected": 1,
"missing": 1,
"legacy": 1,
"invalid": 1,
"skipped": 1,
"unfinished": 1,
"completedFinding": 1,
"completedClean": 1,
"completedInsufficientEvidence": 1,
"dropReasons": {}
},
"completionOutcome": "<string>",
"coverageScope": {
"kind": "repository"
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}Read an existing security scan (beta)
Follow a specific scan by repository and scan ID. Returns status, recorded start and completion times, finding counts, coverage and, when available, counts of assigned and completed investigation checks. Missing investigation data is unknown. A missing scan is null.
GET
/
v1
/
security
/
repositories
/
{repository_id}
/
scans
/
{scan_id}
Read an existing security scan
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}"
headers = {"x-coderabbitai-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-coderabbitai-api-key': '<api-key>'}};
fetch('https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"scan": {
"status": "pending",
"failure": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"scanId": "<string>",
"directoryRetryable": true,
"directoryRetryRepoId": "<string>"
},
"hasPreviousResults": true,
"scanMode": "<string>",
"isPartial": true,
"deferredReason": "<string>",
"counts": {
"total": 123,
"critical": 123,
"high": 123,
"medium": 123,
"low": 123,
"verifiedActive": 123
},
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"investigation": {
"expected": 1,
"missing": 1,
"legacy": 1,
"invalid": 1,
"skipped": 1,
"unfinished": 1,
"completedFinding": 1,
"completedClean": 1,
"completedInsufficientEvidence": 1,
"dropReasons": {}
},
"completionOutcome": "<string>",
"coverageScope": {
"kind": "repository"
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 1
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 1
}
}- CLI Tool
- MCP Server
coderabbit api request "/security/repositories/$REPOSITORY_ID/scans/$SCAN_ID?target=code"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_security_scan tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_security_scan",
"arguments": {
"repository_id": "<repository_id>",
"scan_id": "<scan_id>",
"target": "code"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Path Parameters
Query Parameters
Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.
Minimum string length:
1Was this page helpful?