Public API v1 → Get SQLi Connection Endpoint
About the /configs/sqlConnection endpoint
The /configs/sqlConnection endpoint returns the connection string and port number of Incorta SQL Interface (SQLi), enabling integrated applications to run queries against Incorta SQL Engine.
Any tenant user can use the /configs/sqlConnection to get the SQLi connection string of the respective cluster.
For information about how to get started with Public API v1, refer to References → Public API v1.
Note
You must use the HTTPS scheme to be able to successfully run the API endpoints.
Request URL
https://<cluster_URL>/incorta/api/v1//configs/sqlConnection
HTTP method
GET
Request headers
{"Content-Type": "text/plain","Accept": "application/json","Authorization": "Bearer {access_token}"}
You must use a valid access token of a tenant user.
For information about how to create an access token, refer to Public API v1 → Create Token Endpoint.
Endpoint response
The following table shows the HTTP response status codes for this endpoint.
| Code | Description | Payload Response |
|---|---|---|
| 200 | The endpoint returns the SQLi connection string and port number. | The response contains the connection string and port number as plain text. Example: cluster1.sqli.incortacloud.com:15926 |
| 500 | The endpoint couldn’t retrieve the connection string and port due to authentication errors, such as an invalid or expired access token. | {"message": "string"} Example: {"INC_09030101: Invalid access token or access token may have expired."} |
| 503 | Service Unavailable | {"message": "string"} |