Retry or resume a specific Deep Scan
curl --request POST \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}/recover \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"recovery": {
"action": "retry"
},
"org_id": "<string>",
"org_name": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}/recover"
payload = {
"recovery": { "action": "retry" },
"org_id": "<string>",
"org_name": "<string>"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({recovery: {action: 'retry'}, org_id: '<string>', org_name: '<string>'})
};
fetch('https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}/recover', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "triggered",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"blocked_reason": "<string>",
"retry_after_seconds": 123
}{
"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
}
}Retry or resume a specific Deep Scan (beta)
Retry an eligible failed scan using its saved scan kind, or resume an eligible partial scan with an explicit spend limit in cents. Native admission checks apply. A triggered result is an accepted dispatch. Use its scan_id to follow the new run. Inspect scan history before replaying an uncertain write.
POST
/
v1
/
security
/
repositories
/
{repository_id}
/
scans
/
{scan_id}
/
recover
Retry or resume a specific Deep Scan
curl --request POST \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}/recover \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"recovery": {
"action": "retry"
},
"org_id": "<string>",
"org_name": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}/recover"
payload = {
"recovery": { "action": "retry" },
"org_id": "<string>",
"org_name": "<string>"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({recovery: {action: 'retry'}, org_id: '<string>', org_name: '<string>'})
};
fetch('https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scans/{scan_id}/recover', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "triggered",
"scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>",
"blocked_reason": "<string>",
"retry_after_seconds": 123
}{
"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/recover" --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
recover_security_scan tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "recover_security_scan",
"arguments": {
"repository_id": "<repository_id>",
"scan_id": "<scan_id>",
"recovery": "<recovery>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
Path Parameters
Body
application/json
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?