Skip to content

Connections

Connections are used to connect to external data sources. You can create, delete, and browse connections using the API.

  • Connection must be attached to applications to be used.
  • First connection in the list is the default connection for the application.

Connections

Browse connections

app_administrator

HTTP
GET {{host}}/api/core/connections/browse
Authorization: Basic api:{{token}}

Connection details with all objects and definitions

sys_query_{connectionName}

HTTP
GET {{host}}/api/core/connections/browse/{{connectionName}}
Authorization: Basic api:{{token}}

Connection status

sys_query_{connectionName}

Status of the connection and response time.

HTTP
GET {{host}}/api/core/connections/status/{{connectionName}}
Authorization: Basic api:{{token}}

Connection delete

app_administrator

HTTP
POST {{host}}/api/core/connections/delete/{{connectionName}}
Authorization: Basic api:{{token}}

Connection create

app_administrator v2228

Notes:

  • Connect Timeout is a connect timeout in seconds.
  • Command Timeout is a query timeout in seconds (default 60s)
  • Encrypt=True must be specify explicitly, if not provided connection will not be encrypted Encrypted=False will be added to the connection string.
HTTP
1
2
3
4
5
6
7
8
9
POST {{host}}/api/core/connections/create/{{connectionName}}
Authorization: Basic api:{{token}}
Content-Type: application/json

{
  "name": "{{connectionName}}",
  "type":"mssql",
  "value": "Server=xxxx;Database=xxxx;User Id=xxxx;Password=xxxx;Connect Timeout=7;Command Timeout=30" 
}

Connections strings examples

Examples

Standard Connection to SQL Server / Azure SQL / Amazon RDS:

Text Only
Server=xxxx;Database=xxxx;User Id=xxxx;Password=xxxx;Connect Timeout=7;Command Timeout=30

Trusted Connection:

Text Only
Server=myServerAddress;Database=myDataBase;Trusted_Connection=True;

Instance Connection:

Text Only
Server=myServerNamemyInstanceName;Database=myDataBase;User Id=myUsername; Password=myPassword;