Read a runtime validation result
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_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}/validations/{validation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"validation": {
"schemaVersion": 1,
"status": "pending",
"locator": {
"schemaVersion": 1,
"validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"provider": "github",
"id": "<string>"
},
"findingIdentityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"findingOccurrenceId": "<string>",
"scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"progress": {
"schemaVersion": 1,
"locator": {
"schemaVersion": 1,
"validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"provider": "github",
"id": "<string>"
},
"findingIdentityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"findingOccurrenceId": "<string>",
"scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"taskId": "<string>",
"writerGeneration": 1,
"sequence": 1,
"executionStatus": "queued",
"occurredAt": "2023-11-07T05:31:56Z",
"reason": {
"code": "setup_failed",
"message": "<string>"
}
}
},
"manifest": {
"schemaVersion": 1,
"locator": {
"schemaVersion": 1,
"validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"provider": "github",
"id": "<string>"
},
"findingIdentityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"findingOccurrenceId": "<string>",
"scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"taskId": "<string>",
"provenance": {
"schemaVersion": 1,
"scanRevision": "<string>",
"scanArtifact": {
"artifactId": "<string>",
"sha256": "<string>"
},
"sourceReferences": [
{
"filePath": "<string>",
"startLine": 1,
"endLine": 1,
"artifactId": "<string>"
}
],
"target": {
"defaultBranch": "<string>",
"revision": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z"
}
},
"environment": {
"fingerprint": "<string>",
"baseSnapshotId": "<string>",
"artifactId": "<string>",
"configuration": {
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environmentRevision": 1,
"repositoryConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 1
}
}
},
"recipe": {
"artifactId": "<string>",
"sha256": "<string>",
"testArtifactIds": [
"<string>"
],
"fixtureArtifactIds": [
"<string>"
],
"expectedSecurityEffect": "<string>",
"prerequisites": [
"<string>"
],
"controls": [
{
"controlId": "<string>",
"description": "<string>"
}
]
},
"execution": {
"executorVersion": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"status": "completed",
"freshReplay": true,
"sourceIntegrity": "unchanged",
"applicationReady": true,
"targetPathExercised": true,
"securityEffect": "observed",
"evidenceArtifactIds": [
"<string>"
],
"controls": [
{
"controlId": "<string>",
"status": "passed",
"evidenceArtifactIds": [
"<string>"
]
}
]
},
"assessment": {
"schemaVersion": 1,
"assessorVersion": "<string>",
"conclusion": "reproduced",
"summary": "<string>",
"reason": {
"code": "setup_failed",
"message": "<string>"
},
"evidenceArtifactIds": [
"<string>"
],
"counterevidence": [
"<string>"
],
"limitations": [
"<string>"
]
},
"artifacts": [
{
"schemaVersion": 1,
"artifactId": "<string>",
"kind": "source",
"mediaType": "<string>",
"byteLength": 13107200,
"sha256": "<string>",
"redaction": "not_needed",
"truncated": true
}
]
}
}{
"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 runtime validation result
Uses existing runtime validation permissions and product availability. Evidence unavailability remains explicit.
GET
/
v1
/
security
/
repositories
/
{repository_id}
/
validations
/
{validation_id}
Read a runtime validation result
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id} \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_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}/validations/{validation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"validation": {
"schemaVersion": 1,
"status": "pending",
"locator": {
"schemaVersion": 1,
"validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"provider": "github",
"id": "<string>"
},
"findingIdentityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"findingOccurrenceId": "<string>",
"scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"progress": {
"schemaVersion": 1,
"locator": {
"schemaVersion": 1,
"validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"provider": "github",
"id": "<string>"
},
"findingIdentityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"findingOccurrenceId": "<string>",
"scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"taskId": "<string>",
"writerGeneration": 1,
"sequence": 1,
"executionStatus": "queued",
"occurredAt": "2023-11-07T05:31:56Z",
"reason": {
"code": "setup_failed",
"message": "<string>"
}
}
},
"manifest": {
"schemaVersion": 1,
"locator": {
"schemaVersion": 1,
"validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"repository": {
"provider": "github",
"id": "<string>"
},
"findingIdentityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"findingOccurrenceId": "<string>",
"scanId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"taskId": "<string>",
"provenance": {
"schemaVersion": 1,
"scanRevision": "<string>",
"scanArtifact": {
"artifactId": "<string>",
"sha256": "<string>"
},
"sourceReferences": [
{
"filePath": "<string>",
"startLine": 1,
"endLine": 1,
"artifactId": "<string>"
}
],
"target": {
"defaultBranch": "<string>",
"revision": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z"
}
},
"environment": {
"fingerprint": "<string>",
"baseSnapshotId": "<string>",
"artifactId": "<string>",
"configuration": {
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environmentRevision": 1,
"repositoryConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 1
}
}
},
"recipe": {
"artifactId": "<string>",
"sha256": "<string>",
"testArtifactIds": [
"<string>"
],
"fixtureArtifactIds": [
"<string>"
],
"expectedSecurityEffect": "<string>",
"prerequisites": [
"<string>"
],
"controls": [
{
"controlId": "<string>",
"description": "<string>"
}
]
},
"execution": {
"executorVersion": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"status": "completed",
"freshReplay": true,
"sourceIntegrity": "unchanged",
"applicationReady": true,
"targetPathExercised": true,
"securityEffect": "observed",
"evidenceArtifactIds": [
"<string>"
],
"controls": [
{
"controlId": "<string>",
"status": "passed",
"evidenceArtifactIds": [
"<string>"
]
}
]
},
"assessment": {
"schemaVersion": 1,
"assessorVersion": "<string>",
"conclusion": "reproduced",
"summary": "<string>",
"reason": {
"code": "setup_failed",
"message": "<string>"
},
"evidenceArtifactIds": [
"<string>"
],
"counterevidence": [
"<string>"
],
"limitations": [
"<string>"
]
},
"artifacts": [
{
"schemaVersion": 1,
"artifactId": "<string>",
"kind": "source",
"mediaType": "<string>",
"byteLength": 13107200,
"sha256": "<string>",
"redaction": "not_needed",
"truncated": true
}
]
}
}{
"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/validations/$VALIDATION_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_security_runtime_validation tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_security_runtime_validation",
"arguments": {
"repository_id": "<repository_id>",
"validation_id": "<validation_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:
1Was this page helpful?