Public API v2 → 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 v2, refer to References → Public API v2.
You must use the HTTPS scheme to be able to successfully run the API endpoints. Additionally, you must specify the tenant name (case-sensitive) in the endpoint request URL starting with the 2023.7.0 release.
Request URL
https://<cluster_URL>/incorta/api/v2/{tenantName}/configs/sqlConnection
Request URL Parameter
| Field name | Description | Type | Required |
|---|---|---|---|
| tenantName | The tenant name (case-sensitive) | String | Required starting with 2023.7.0 |
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 v2 → Create an API access token.
Endpoint response
The following table shows the HTTP response status codes for this endpoint.
| Code | Description | Payload Response |
|---|---|---|
| 200 | OK 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 |
| 400 | Bad Request Invalid parameters or method | {"message": "string"} |
| 401 | Unauthorized The endpoint couldn’t retrieve the connection string and port due to authentication errors, such as an invalid or expired access token. | {"message": "string"} Examples: {"INC_09030101: Invalid personal access token."} "INC_09030108: Invalid authentication header. Invalid Token [abc123]" |
| 404 | Not found The tenant doesn't exist or is disabled. | {"message": "string"} Example: {"message": Invalid [TestTenantName] tenant in resource path"} |
| 500 | Internal Server Error | {"message": "string"} |
| 503 | Service Unavailable | {"message": "string"} Example: "Something went wrong with Analytics/CMC service. Please check Incorta services status." |