Skip to main content
POST
Test a connection with existing credential and provider checks

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Body

application/json
connection
object
required
org_id
string

Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id.

Minimum string length: 1
connectionId
string<uuid>

Response

OK

ok
any
required
Available options:
true
message
string
required