Activate, pause, or resume a Triage rule

curl --request POST \
  --url https://api.coderabbit.ai/v1/triage/rules/{ruleId}/transition \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "revision": 1,
  "retentionSetup": true,
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/triage/rules/{ruleId}/transition"

payload = {
    "revision": 1,
    "retentionSetup": True,
    "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({revision: 1, retentionSetup: true, org_id: '<string>', org_name: '<string>'})
};

fetch('https://api.coderabbit.ai/v1/triage/rules/{ruleId}/transition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "<string>",
  "revision": 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
  }
}

POST

triage

rules

{ruleId}

transition

Activate, pause, or resume a Triage rule

curl --request POST \
  --url https://api.coderabbit.ai/v1/triage/rules/{ruleId}/transition \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "revision": 1,
  "retentionSetup": true,
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/triage/rules/{ruleId}/transition"

payload = {
    "revision": 1,
    "retentionSetup": True,
    "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({revision: 1, retentionSetup: true, org_id: '<string>', org_name: '<string>'})
};

fetch('https://api.coderabbit.ai/v1/triage/rules/{ruleId}/transition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "<string>",
  "revision": 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 "/triage/rules/$RULE_ID/transition" --input request.json

To install and sign in to the CLI, see Call from the CLI.

An agent connected to the CodeRabbit MCP server runs this operation as the transition_triage_rule tool. The connection selects the organization, so the arguments have no org_id or org_name.

{
  "method": "tools/call",
  "params": {
    "name": "transition_triage_rule",
    "arguments": {
      "ruleId": "<ruleId>",
      "revision": 1,
      "operation": "activate"
    }
  }
}

Authorizations

x-coderabbitai-api-key

string

header

required

See Authentication for the key types and where to create a key.

Path Parameters

ruleId

string<uuid>

required

Body

application/json

revision

integer

required

Required range: x > 0

operation

enum<string>

required

Available options:

activate,

pause,

resume

retentionSetup

any

Available options:

true

org_id

string

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: 1

org_name

string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

Response

status

string

required

revision

integer

required

Basics

Clients

Guides

API reference

Activate, pause, or resume a Triage rule

Authorizations

Path Parameters

Body

Response