1. Home
  2. Previous Releases
  3. Latest Release
  4. Guides
  5. Concepts
  6. Tools
  7. References
    1. Apache Spark
    2. Built-in Functions
    3. Incorta Component SDK
    4. Incorta Connector SDK
    5. Connectors
    6. Data Studio
    7. Public API
      1. Public API v2
        1. Create External Schema
        2. Extract to External Table
        3. Append to External Table
        4. Delete External Table
        5. Delete External Schema
        6. List Catalog Content
        7. List Catalog Folder Content
        8. Search Catalog Content
        9. Create Catalog Folder
        10. Get SQLi Connectiont
        11. Schedule Dashboard Report
        12. Dashboard Prompts
        13. Rename & Move Dashboards
        14. Insight Query
        15. Execute Load Plan
        16. Load Plan Execution Status
        17. Query a Business View
        18. Load Schema
        19. Schema Status
        20. List Schemas
        21. List Schema Objects
        22. Reset Passwords
        23. Transfer Ownership
    8. Security
    9. SQL Interface
    10. Visualizations
    11. Other
  8. Integrations
  9. Data applications
  10. Releases
  11. Incorta Premium

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.

Important

This endpoint is available only on Cloud installations.

For information about how to get started with Public API v2, refer to References → Public API v2.

Note

You must use the HTTPS scheme to successfully run the API endpoints on Cloud installations.

Request URL

https://<cluster_URL>/incorta/api/v2/{tenantName}/configs/sqlConnection

Request URL Parameter

Field nameDescriptionTypeRequired
tenantNameThe tenant name (case-sensitive)StringRequired

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.

CodeDescriptionPayload Response
200OK
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
400Bad Request
Invalid parameters or method		{"message": "string"}
401Unauthorized
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]"
404Not found
The tenant doesn't exist or is disabled.		{"message": "string"}
Example:
{"message": Invalid [TestTenantName] tenant in resource path"}
500Internal Server Error{"message": "string"}
503Service Unavailable
{"message": "string"}
Example:
"Something went wrong with Analytics/CMC service. Please check Incorta services status."