Test a connection with existing credential and provider checks
curl --request POST \
--url https://api.coderabbit.ai/v1/connections/test \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"connection": {
"connectionName": "<string>",
"description": "<string>",
"fieldValues": {},
"apiKeys": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>"
}
],
"mcp": {
"enabled": true,
"serverName": "<string>",
"serverUrl": "<string>",
"authHeaderName": "<string>",
"authHeaderValue": "<string>"
},
"salesforceServiceAccount": {
"flow": "client_credentials",
"clientId": "<string>",
"myDomainUrl": "<string>"
},
"connectionPurpose": "runtime_access",
"envVars": [],
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"salesforceServiceAccountSecret": {
"flow": "client_credentials",
"clientSecret": "<string>"
}
},
"org_id": "<string>",
"org_name": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.coderabbit.ai/v1/connections/test"
payload = {
"connection": {
"connectionName": "<string>",
"description": "<string>",
"fieldValues": {},
"apiKeys": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>"
}
],
"mcp": {
"enabled": True,
"serverName": "<string>",
"serverUrl": "<string>",
"authHeaderName": "<string>",
"authHeaderValue": "<string>"
},
"salesforceServiceAccount": {
"flow": "client_credentials",
"clientId": "<string>",
"myDomainUrl": "<string>"
},
"connectionPurpose": "runtime_access",
"envVars": [],
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"salesforceServiceAccountSecret": {
"flow": "client_credentials",
"clientSecret": "<string>"
}
},
"org_id": "<string>",
"org_name": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
connection: {
connectionName: '<string>',
description: '<string>',
fieldValues: {},
apiKeys: [{id: '<string>', name: '<string>', value: '<string>'}],
mcp: {
enabled: true,
serverName: '<string>',
serverUrl: '<string>',
authHeaderName: '<string>',
authHeaderValue: '<string>'
},
salesforceServiceAccount: {flow: 'client_credentials', clientId: '<string>', myDomainUrl: '<string>'},
connectionPurpose: 'runtime_access',
envVars: [],
expectedUpdatedAt: '2023-11-07T05:31:56Z',
salesforceServiceAccountSecret: {flow: 'client_credentials', clientSecret: '<string>'}
},
org_id: '<string>',
org_name: '<string>',
connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.coderabbit.ai/v1/connections/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ok": true,
"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
}
}Test a connection with existing credential and provider checks
Checks the supplied connection configuration with its credential and provider checks, and returns ok with a message or a failure code. connectionId identifies an existing saved connection. Requires workspace_integration_management:write.
POST
/
v1
/
connections
/
test
Test a connection with existing credential and provider checks
curl --request POST \
--url https://api.coderabbit.ai/v1/connections/test \
--header 'Content-Type: application/json' \
--header 'x-coderabbitai-api-key: <api-key>' \
--data '
{
"connection": {
"connectionName": "<string>",
"description": "<string>",
"fieldValues": {},
"apiKeys": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>"
}
],
"mcp": {
"enabled": true,
"serverName": "<string>",
"serverUrl": "<string>",
"authHeaderName": "<string>",
"authHeaderValue": "<string>"
},
"salesforceServiceAccount": {
"flow": "client_credentials",
"clientId": "<string>",
"myDomainUrl": "<string>"
},
"connectionPurpose": "runtime_access",
"envVars": [],
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"salesforceServiceAccountSecret": {
"flow": "client_credentials",
"clientSecret": "<string>"
}
},
"org_id": "<string>",
"org_name": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.coderabbit.ai/v1/connections/test"
payload = {
"connection": {
"connectionName": "<string>",
"description": "<string>",
"fieldValues": {},
"apiKeys": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>"
}
],
"mcp": {
"enabled": True,
"serverName": "<string>",
"serverUrl": "<string>",
"authHeaderName": "<string>",
"authHeaderValue": "<string>"
},
"salesforceServiceAccount": {
"flow": "client_credentials",
"clientId": "<string>",
"myDomainUrl": "<string>"
},
"connectionPurpose": "runtime_access",
"envVars": [],
"expectedUpdatedAt": "2023-11-07T05:31:56Z",
"salesforceServiceAccountSecret": {
"flow": "client_credentials",
"clientSecret": "<string>"
}
},
"org_id": "<string>",
"org_name": "<string>",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
connection: {
connectionName: '<string>',
description: '<string>',
fieldValues: {},
apiKeys: [{id: '<string>', name: '<string>', value: '<string>'}],
mcp: {
enabled: true,
serverName: '<string>',
serverUrl: '<string>',
authHeaderName: '<string>',
authHeaderValue: '<string>'
},
salesforceServiceAccount: {flow: 'client_credentials', clientId: '<string>', myDomainUrl: '<string>'},
connectionPurpose: 'runtime_access',
envVars: [],
expectedUpdatedAt: '2023-11-07T05:31:56Z',
salesforceServiceAccountSecret: {flow: 'client_credentials', clientSecret: '<string>'}
},
org_id: '<string>',
org_name: '<string>',
connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.coderabbit.ai/v1/connections/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"ok": true,
"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 /connections/test --input request.json
An agent connected to the CodeRabbit MCP server runs this operation as the
test_connection tool. The connection selects the organization, so the arguments have no org_id or org_name.{
"method": "tools/call",
"params": {
"name": "test_connection",
"arguments": {
"connection": {}
}
}
}
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?