Skip to main content
PATCH
Update a connection's name or description
To install and sign in to the CLI, see Call from the CLI.

Authorizations

x-coderabbitai-api-key
string
header
required

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

Path Parameters

connectionId
string<uuid>
required

Body

application/json
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}$
connection_purpose
enum<string>
default:runtime_access
Available options:
runtime_access,
trigger_source
name
string
Required string length: 2 - 160
description
string
Maximum string length: 10000

Response

OK

connection
object
required