Read a code security finding
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_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}/findings/{finding_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"repoId": "<string>",
"repoName": "<string>",
"category": "<string>",
"severity": "<string>",
"source": "<string>",
"reachability": "<string>",
"exploitability": "<string>",
"filePath": "<string>",
"startLine": 123,
"endLine": 123,
"description": "<string>",
"recommendation": "<string>",
"cwe": "<string>",
"state": "<string>",
"detectedAt": "<string>",
"fingerprint": "<string>",
"fixStatus": "<string>",
"fixPrUrl": "<string>",
"verificationSteps": "<string>",
"publicationStatus": "published",
"reachabilityCallStack": [
"<string>"
],
"reachabilityZoneContext": {
"schemaVersion": 1,
"scanId": "<string>",
"artifactScanId": "<string>",
"capturedAt": "2023-11-07T05:31:56Z",
"zone": "<string>",
"label": "external",
"source": "settings",
"evidence": "<string>",
"headRevision": "<string>",
"confidence": "high",
"reconSha256": "<string>",
"rule": {
"id": "<string>",
"path": "<string>",
"reachability": "external",
"setAt": "2023-11-07T05:31:56Z",
"setBy": {
"providerUserId": "<string>",
"login": "<string>"
}
}
},
"subsystemName": "<string>",
"firstSeenAt": "<string>",
"lastSeenAt": "<string>",
"scanProvenance": {
"scanId": "<string>",
"coverageScope": {
"kind": "repository"
}
},
"secretAssessment": {
"policyVersion": "2026-10-01",
"status": "assessed",
"classification": "public_config",
"confidence": "high",
"environment": "production",
"impact": "privileged_access",
"reason": "public_provider_role",
"missingEvidence": [
"usage"
],
"scanVerification": "<string>",
"verificationCheckedAt": "2023-11-07T05:31:56Z",
"verification": "valid",
"detectors": [
"<string>"
],
"relatedLocations": [
{
"file": "<string>",
"startLine": 1,
"endLine": 1
}
]
},
"findingKind": "secret",
"cvssScore": 5,
"fixTaskId": "<string>",
"tickets": [
{
"provider": "jira",
"status": "<string>",
"url": "<string>"
}
],
"kbSources": [
{
"kb": "<string>",
"path": "<string>",
"url": "<string>"
}
]
}{
"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 a code security finding (beta)
Returns one code security finding with its severity, location, description, recommendation, state and fix status, including any fix task or pull request and tracker ticket delivery status and URLs.
GET
/
v1
/
security
/
repositories
/
{repository_id}
/
findings
/
{finding_id}
Read a code security finding
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/findings/{finding_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}/findings/{finding_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"repoId": "<string>",
"repoName": "<string>",
"category": "<string>",
"severity": "<string>",
"source": "<string>",
"reachability": "<string>",
"exploitability": "<string>",
"filePath": "<string>",
"startLine": 123,
"endLine": 123,
"description": "<string>",
"recommendation": "<string>",
"cwe": "<string>",
"state": "<string>",
"detectedAt": "<string>",
"fingerprint": "<string>",
"fixStatus": "<string>",
"fixPrUrl": "<string>",
"verificationSteps": "<string>",
"publicationStatus": "published",
"reachabilityCallStack": [
"<string>"
],
"reachabilityZoneContext": {
"schemaVersion": 1,
"scanId": "<string>",
"artifactScanId": "<string>",
"capturedAt": "2023-11-07T05:31:56Z",
"zone": "<string>",
"label": "external",
"source": "settings",
"evidence": "<string>",
"headRevision": "<string>",
"confidence": "high",
"reconSha256": "<string>",
"rule": {
"id": "<string>",
"path": "<string>",
"reachability": "external",
"setAt": "2023-11-07T05:31:56Z",
"setBy": {
"providerUserId": "<string>",
"login": "<string>"
}
}
},
"subsystemName": "<string>",
"firstSeenAt": "<string>",
"lastSeenAt": "<string>",
"scanProvenance": {
"scanId": "<string>",
"coverageScope": {
"kind": "repository"
}
},
"secretAssessment": {
"policyVersion": "2026-10-01",
"status": "assessed",
"classification": "public_config",
"confidence": "high",
"environment": "production",
"impact": "privileged_access",
"reason": "public_provider_role",
"missingEvidence": [
"usage"
],
"scanVerification": "<string>",
"verificationCheckedAt": "2023-11-07T05:31:56Z",
"verification": "valid",
"detectors": [
"<string>"
],
"relatedLocations": [
{
"file": "<string>",
"startLine": 1,
"endLine": 1
}
]
},
"findingKind": "secret",
"cvssScore": 5,
"fixTaskId": "<string>",
"tickets": [
{
"provider": "jira",
"status": "<string>",
"url": "<string>"
}
],
"kbSources": [
{
"kb": "<string>",
"path": "<string>",
"url": "<string>"
}
]
}{
"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/findings/$FINDING_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_security_finding tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_security_finding",
"arguments": {
"repository_id": "<repository_id>",
"finding_id": "<finding_id>"
}
}
}
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:
1Response
OK
Was this page helpful?