Show Menu

Connection parameters

Sample API calls

Now that you understand what headers to use, you are ready to begin making calls to the Query Service API. The following sections walk through the various API calls you can make using the Query Service API. Each call includes the general API format, a sample request showing required headers, and a sample response.

Request connection parameters for the interactive service

You can retrieve your connection parameters for using the interactive service by making a GET request to the /connection_parameters endpoint. For more information about clients that use connection parameters to connect via the interactive service, please read the documentation on Query Service clients .
API format
GET /connection_parameters

curl -X GET
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

A successful response returns HTTP status 200 with your connection parameters.
    "username": "{USERNAME}",
    "dbName": "prod:all",
    "host": "{HOSTNAME}",
    "version": 1,
    "port": 80,
    "token": "{TOKEN}",
    "compressedToken": "{COMPRESSED_TOKEN}",
    "websocketHost": "{WEBSOCKET_HOSTNAME}"