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>",
"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>",
"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>',
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));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coderabbit.ai/v1/connections/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-coderabbitai-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coderabbit.ai/v1/connections/test"
payload := strings.NewReader("{\n \"connection\": {\n \"connectionName\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldValues\": {},\n \"apiKeys\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"mcp\": {\n \"enabled\": true,\n \"serverName\": \"<string>\",\n \"serverUrl\": \"<string>\",\n \"authHeaderName\": \"<string>\",\n \"authHeaderValue\": \"<string>\"\n },\n \"salesforceServiceAccount\": {\n \"flow\": \"client_credentials\",\n \"clientId\": \"<string>\",\n \"myDomainUrl\": \"<string>\"\n },\n \"connectionPurpose\": \"runtime_access\",\n \"envVars\": [],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"salesforceServiceAccountSecret\": {\n \"flow\": \"client_credentials\",\n \"clientSecret\": \"<string>\"\n }\n },\n \"org_id\": \"<string>\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-coderabbitai-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coderabbit.ai/v1/connections/test")
.header("x-coderabbitai-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection\": {\n \"connectionName\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldValues\": {},\n \"apiKeys\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"mcp\": {\n \"enabled\": true,\n \"serverName\": \"<string>\",\n \"serverUrl\": \"<string>\",\n \"authHeaderName\": \"<string>\",\n \"authHeaderValue\": \"<string>\"\n },\n \"salesforceServiceAccount\": {\n \"flow\": \"client_credentials\",\n \"clientId\": \"<string>\",\n \"myDomainUrl\": \"<string>\"\n },\n \"connectionPurpose\": \"runtime_access\",\n \"envVars\": [],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"salesforceServiceAccountSecret\": {\n \"flow\": \"client_credentials\",\n \"clientSecret\": \"<string>\"\n }\n },\n \"org_id\": \"<string>\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coderabbit.ai/v1/connections/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection\": {\n \"connectionName\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldValues\": {},\n \"apiKeys\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"mcp\": {\n \"enabled\": true,\n \"serverName\": \"<string>\",\n \"serverUrl\": \"<string>\",\n \"authHeaderName\": \"<string>\",\n \"authHeaderValue\": \"<string>\"\n },\n \"salesforceServiceAccount\": {\n \"flow\": \"client_credentials\",\n \"clientId\": \"<string>\",\n \"myDomainUrl\": \"<string>\"\n },\n \"connectionPurpose\": \"runtime_access\",\n \"envVars\": [],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"salesforceServiceAccountSecret\": {\n \"flow\": \"client_credentials\",\n \"clientSecret\": \"<string>\"\n }\n },\n \"org_id\": \"<string>\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"message": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 4503599627370495
}
}Test a connection with existing credential and provider checks
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>",
"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>",
"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>',
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));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coderabbit.ai/v1/connections/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>',
'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-coderabbitai-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.coderabbit.ai/v1/connections/test"
payload := strings.NewReader("{\n \"connection\": {\n \"connectionName\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldValues\": {},\n \"apiKeys\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"mcp\": {\n \"enabled\": true,\n \"serverName\": \"<string>\",\n \"serverUrl\": \"<string>\",\n \"authHeaderName\": \"<string>\",\n \"authHeaderValue\": \"<string>\"\n },\n \"salesforceServiceAccount\": {\n \"flow\": \"client_credentials\",\n \"clientId\": \"<string>\",\n \"myDomainUrl\": \"<string>\"\n },\n \"connectionPurpose\": \"runtime_access\",\n \"envVars\": [],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"salesforceServiceAccountSecret\": {\n \"flow\": \"client_credentials\",\n \"clientSecret\": \"<string>\"\n }\n },\n \"org_id\": \"<string>\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-coderabbitai-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.coderabbit.ai/v1/connections/test")
.header("x-coderabbitai-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection\": {\n \"connectionName\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldValues\": {},\n \"apiKeys\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"mcp\": {\n \"enabled\": true,\n \"serverName\": \"<string>\",\n \"serverUrl\": \"<string>\",\n \"authHeaderName\": \"<string>\",\n \"authHeaderValue\": \"<string>\"\n },\n \"salesforceServiceAccount\": {\n \"flow\": \"client_credentials\",\n \"clientId\": \"<string>\",\n \"myDomainUrl\": \"<string>\"\n },\n \"connectionPurpose\": \"runtime_access\",\n \"envVars\": [],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"salesforceServiceAccountSecret\": {\n \"flow\": \"client_credentials\",\n \"clientSecret\": \"<string>\"\n }\n },\n \"org_id\": \"<string>\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coderabbit.ai/v1/connections/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-coderabbitai-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection\": {\n \"connectionName\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldValues\": {},\n \"apiKeys\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"mcp\": {\n \"enabled\": true,\n \"serverName\": \"<string>\",\n \"serverUrl\": \"<string>\",\n \"authHeaderName\": \"<string>\",\n \"authHeaderValue\": \"<string>\"\n },\n \"salesforceServiceAccount\": {\n \"flow\": \"client_credentials\",\n \"clientId\": \"<string>\",\n \"myDomainUrl\": \"<string>\"\n },\n \"connectionPurpose\": \"runtime_access\",\n \"envVars\": [],\n \"expectedUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"salesforceServiceAccountSecret\": {\n \"flow\": \"client_credentials\",\n \"clientSecret\": \"<string>\"\n }\n },\n \"org_id\": \"<string>\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"message": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "head_changed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "precondition_failed",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "payload_too_large",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"retry_after": 4503599627370495
}
}{
"error": {
"code": "unavailable",
"message": "<string>",
"retry_after": 4503599627370495
}
}Authorizations
API key for authentication. You can create an API key from the CodeRabbit dashboard.
Body
application/json
Was this page helpful?