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));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-coderabbitai-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-coderabbitai-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}")
.header("x-coderabbitai-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": 4503599627370495,
"sequence": 4503599627370495,
"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": 4503599627370495,
"endLine": 4503599627370495,
"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": 4503599627370495,
"repositoryConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 4503599627370495
}
}
},
"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": 4503599627370495
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 4503599627370495
}
}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));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-coderabbitai-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-coderabbitai-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}")
.header("x-coderabbitai-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coderabbit.ai/v1/security/repositories/{repository_id}/validations/{validation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": 4503599627370495,
"sequence": 4503599627370495,
"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": 4503599627370495,
"endLine": 4503599627370495,
"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": 4503599627370495,
"repositoryConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 4503599627370495
}
}
},
"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": 4503599627370495
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 4503599627370495
}
}Authorizations
API key for authentication. You can create an API key from the CodeRabbit dashboard.
Path Parameters
Required string length:
1 - 255Query Parameters
Minimum string length:
1Was this page helpful?