Update a connection's name or description
curl --request PATCH \
--url https://api.coderabbit.ai/v1/connections/{connectionId} \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"org_id": "<string>",
"org_name": "<string>",
"connection_purpose": "runtime_access",
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/connections/{connectionId}"
payload = {
"org_id": "<string>",
"org_name": "<string>",
"connection_purpose": "runtime_access",
"name": "<string>",
"description": "<string>"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
org_id: '<string>',
org_name: '<string>',
connection_purpose: 'runtime_access',
name: '<string>',
description: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/connections/{connectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"connection": {
"integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "amplemarket",
"connectionName": "<string>",
"description": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"mcp": {
"enabled": true,
"serverOrigin": "<string>",
"transport": "sse",
"authMethod": "none",
"allowedTools": [
"<string>"
]
},
"connectionPurpose": "runtime_access",
"policyMode": "read_only",
"requiresReconnect": false,
"hasOAuthGrant": 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
}
}Update a connection's name or description
Updates only display metadata. Existing provider configuration and stored credentials are preserved by the native save operation. GET returns credential-free metadata; PUT remains a full configuration replacement.
PATCH
/
v1
/
connections
/
{connectionId}
Update a connection's name or description
curl --request PATCH \
--url https://api.coderabbit.ai/v1/connections/{connectionId} \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"org_id": "<string>",
"org_name": "<string>",
"connection_purpose": "runtime_access",
"name": "<string>",
"description": "<string>"
}
'import requests
url = "https://api.coderabbit.ai/v1/connections/{connectionId}"
payload = {
"org_id": "<string>",
"org_name": "<string>",
"connection_purpose": "runtime_access",
"name": "<string>",
"description": "<string>"
}
headers = {
"x-coderabbitai-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
org_id: '<string>',
org_name: '<string>',
connection_purpose: 'runtime_access',
name: '<string>',
description: '<string>'
})
};
fetch('https://api.coderabbit.ai/v1/connections/{connectionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"connection": {
"integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "amplemarket",
"connectionName": "<string>",
"description": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"mcp": {
"enabled": true,
"serverOrigin": "<string>",
"transport": "sse",
"authMethod": "none",
"allowedTools": [
"<string>"
]
},
"connectionPurpose": "runtime_access",
"policyMode": "read_only",
"requiresReconnect": false,
"hasOAuthGrant": 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 -X PATCH "/connections/$CONNECTION_ID"
An agent connected to the CodeRabbit MCP server runs this operation as the
patch_connection_metadata tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "patch_connection_metadata",
"arguments": {
"connectionId": "<connectionId>"
}
}
}
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?