Run, pause, resume, or delete an ordinary Automation
curl --request POST \
--url https://api.coderabbit.ai/v1/automations/{automation_id}/commands \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"expected_revision": 1,
"org_id": "<string>",
"org_name": "<string>",
"message_platform_provider": "slack",
"channel_id": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/automations/{automation_id}/commands"
payload = {
"expected_revision": 1,
"org_id": "<string>",
"org_name": "<string>",
"message_platform_provider": "slack",
"channel_id": "<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({
expected_revision: 1,
org_id: '<string>',
org_name: '<string>',
message_platform_provider: 'slack',
channel_id: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/automations/{automation_id}/commands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"automation_id": "<string>",
"action": "run_now",
"data": {
"id": "<string>",
"title": "<string>",
"summary": "<string>",
"status": "active",
"revision": 1,
"updated_at": "2023-11-07T05:31:56Z",
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"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
}
}Run, pause, resume, or delete an ordinary Automation
Uses native ownership and revision checks. run_now accepts work; poll the recorded runs for completion.
POST
/
v1
/
automations
/
{automation_id}
/
commands
Run, pause, resume, or delete an ordinary Automation
curl --request POST \
--url https://api.coderabbit.ai/v1/automations/{automation_id}/commands \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"expected_revision": 1,
"org_id": "<string>",
"org_name": "<string>",
"message_platform_provider": "slack",
"channel_id": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/automations/{automation_id}/commands"
payload = {
"expected_revision": 1,
"org_id": "<string>",
"org_name": "<string>",
"message_platform_provider": "slack",
"channel_id": "<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({
expected_revision: 1,
org_id: '<string>',
org_name: '<string>',
message_platform_provider: 'slack',
channel_id: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/automations/{automation_id}/commands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"automation_id": "<string>",
"action": "run_now",
"data": {
"id": "<string>",
"title": "<string>",
"summary": "<string>",
"status": "active",
"revision": 1,
"updated_at": "2023-11-07T05:31:56Z",
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"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 "/automations/$AUTOMATION_ID/commands" --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
command_automation tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "command_automation",
"arguments": {
"automation_id": "<automation_id>",
"expected_revision": 1,
"action": "run_now"
}
}
}
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?