Read the repository Deep Scan schedule
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule"
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}/scan-schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "scheduled",
"schedule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"delta": {
"cron": true,
"coverage_target_pct": 50,
"max_commits_since_scan": 1,
"max_days_since_scan": 1,
"spend_limit_cents": 50000500
},
"paid_usage_authorized": 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 the repository Deep Scan schedule (beta)
Returns the schedule, its current billing authorization and the revision required to edit or delete it. Legacy multi-target schedules are managed in the dashboard.
GET
/
v1
/
security
/
repositories
/
{repository_id}
/
scan-schedule
Read the repository Deep Scan schedule
curl --request GET \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule \
--header 'x-coderabbitai-api-key: <api-key>'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule"
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}/scan-schedule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "scheduled",
"schedule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"delta": {
"cron": true,
"coverage_target_pct": 50,
"max_commits_since_scan": 1,
"max_days_since_scan": 1,
"spend_limit_cents": 50000500
},
"paid_usage_authorized": 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/scan-schedule"
An agent connected to the CodeRabbit MCP server runs this operation as the
get_security_scan_schedule tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "get_security_scan_schedule",
"arguments": {
"repository_id": "<repository_id>"
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
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?