Skip to main content
POST
/
api
/
v1
/
sources
/
add
/
mssql
/
Add SQL Server connection
curl --request POST \
  --url https://api.camelai.com/api/v1/sources/add/mssql/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "mssql",
  "hostname": "localhost",
  "port": 1433,
  "username": "sa",
  "password": "Password123!",
  "database_name": "master"
}
'
{
  "id": 123
}

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer scheme

Body

application/json

Serializer for Microsoft SQL Server connection configuration.

​
type
string
required

Connection type identifier. Must be MSSQL

Minimum string length: 1
​
account_name
string
default:SQL Server

Display name for the connection

Minimum string length: 1
​
hostname
string

SQL Server hostname

Required string length: 1 - 255
​
port
integer
default:1433

Port number

​
username
string

Database username

Required string length: 1 - 255
​
password
string
write-only

Database password

Minimum string length: 1
​
database_name
string

Database name

Required string length: 1 - 255
​
connection_string
string

Alternative: ODBC connection string instead of individual parameters

Minimum string length: 1

Response

​
id
integer

The ID of the created connection