Create or edit a repository Deep Scan schedule
curl --request PUT \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"previous": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": "<string>"
},
"cron_expression": "<string>",
"timezone": "<string>",
"approve_paid_usage": true,
"org_id": "<string>",
"org_name": "<string>",
"delta": {
"cron": true,
"coverage_target_pct": 50,
"max_commits_since_scan": 1,
"max_days_since_scan": 1,
"spend_limit_cents": 50000500
}
}
'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule"
payload = {
"previous": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": "<string>"
},
"cron_expression": "<string>",
"timezone": "<string>",
"approve_paid_usage": True,
"org_id": "<string>",
"org_name": "<string>",
"delta": {
"cron": True,
"coverage_target_pct": 50,
"max_commits_since_scan": 1,
"max_days_since_scan": 1,
"spend_limit_cents": 50000500
}
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
previous: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', revision: '<string>'},
cron_expression: '<string>',
timezone: '<string>',
approve_paid_usage: true,
org_id: '<string>',
org_name: '<string>',
delta: {
cron: true,
coverage_target_pct: 50,
max_commits_since_scan: 1,
max_days_since_scan: 1,
spend_limit_cents: 50000500
}
})
};
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));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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
}
}Create or edit a repository Deep Scan schedule (beta)
Pass previous=null to create, or the id and revision returned by get_security_scan_schedule to edit. Supply a cron expression and timezone. Omit delta for full scans. For delta, set exactly one trigger and optionally a spend limit in cents. Paid usage requires explicit approval from a billing admin.
PUT
/
v1
/
security
/
repositories
/
{repository_id}
/
scan-schedule
Create or edit a repository Deep Scan schedule
curl --request PUT \
--url https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"previous": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": "<string>"
},
"cron_expression": "<string>",
"timezone": "<string>",
"approve_paid_usage": true,
"org_id": "<string>",
"org_name": "<string>",
"delta": {
"cron": true,
"coverage_target_pct": 50,
"max_commits_since_scan": 1,
"max_days_since_scan": 1,
"spend_limit_cents": 50000500
}
}
'import requests
url = "https://api.coderabbit.ai/v1/security/repositories/{repository_id}/scan-schedule"
payload = {
"previous": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": "<string>"
},
"cron_expression": "<string>",
"timezone": "<string>",
"approve_paid_usage": True,
"org_id": "<string>",
"org_name": "<string>",
"delta": {
"cron": True,
"coverage_target_pct": 50,
"max_commits_since_scan": 1,
"max_days_since_scan": 1,
"spend_limit_cents": 50000500
}
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
previous: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', revision: '<string>'},
cron_expression: '<string>',
timezone: '<string>',
approve_paid_usage: true,
org_id: '<string>',
org_name: '<string>',
delta: {
cron: true,
coverage_target_pct: 50,
max_commits_since_scan: 1,
max_days_since_scan: 1,
spend_limit_cents: 50000500
}
})
};
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));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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 -X PUT "/security/repositories/$REPOSITORY_ID/scan-schedule" --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
save_security_scan_schedule tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "save_security_scan_schedule",
"arguments": {
"repository_id": "<repository_id>",
"previous": "<previous>",
"cron_expression": "<cron_expression>",
"timezone": "<timezone>",
"approve_paid_usage": false
}
}
}
Authorizations
See Authentication for the key types and where to create a key.
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?