Page tree

Release 6.4.2



For the latest updates on available API endpoints and documentation, see

This is the latest version of the APIs.


Get the specified connection.

For more information on connections, see Connection Types.

Version:  v4

Required Permissions

NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See


Request Type: GET




<id>Internal identifier for the connection

Request URI - Example:


Query parameter reference:

The following query parameters can be submitted with this endpoint:

Query ParameterData TypeDescription

Comma-separated list of objects to include part of the response.


If set to true, response includes deleted objects.

The following parameters are supported specifically for this endpoint:

Query ParameterData TypeDescription


stringThe type of role for which to list connections.

For more information, see API Common Query Parameters v4.

Request Body:



Response Status Code - Success:  200 - OK

Response Body Example:

    "connectParams": {
        "vendor": "hive",
        "vendorName": "hive",
        "host": "hadoop",
        "port": "10000",
        "jdbc": "hive2",
        "defaultDatabase": "default"
    "id": 1,
    "host": "hadoop",
    "port": 10000,
    "vendor": "hive",
    "params": {
        "jdbc": "hive2",
        "connectStringOptions": "",
        "defaultDatabase": "default"
    "ssl": false,
    "vendorName": "hive",
    "name": "hive",
    "description": null,
    "type": "jdbc",
    "isGlobal": true,
    "credentialType": "conf",
    "credentialsShared": true,
    "uuid": "3c8672f0-13ea-11e9-82f7-3ff8e3d74b3f",
    "disableTypeInference": false,
    "createdAt": "2019-01-09T08:40:37.023Z",
    "updatedAt": "2019-01-09T08:40:37.037Z",
    "credentials": [],
    "creator": {
        "id": 1
    "updater": {
        "id": 1
    "workspace": {
        "id": 1


connectParams.vendorThe type of connection. See Connection Types.
connectParams.hostHost of the source
connectParams.portPort number for the source
connectParams.jdbcJDBC type for the connection
connectParams.defaultDatabase(if applicable) Name of the default database
connectParams.extraLoadParams(if applicable) If the connection types supports them, this setting contains additional parameters to be passed to the host when making the connection.
idInternal identifier for the connection
hostHost of the source
portPort number for the source
vendorString identifying the connection's vendor
paramsThis setting is populated with any parameters that are passed to the source during connection and operations. For relational sources, this setting may include the default database and extra load parameters.

When true, the Designer Cloud Powered by Trifacta platform uses SSL to connect to the source.

vendorNameName of the vendor of the connection
nameInternal name of the connection
descriptionUser-friendly description for the connection
typeType of connection

If true, the connection is public and available to all users.

NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated.

Default is false. A connection can be made public through the Connections page. See Connections Page.


The type of credentials used for the connection. This value varies depending on where the credentials are stored.See CLI for Connections.

credentialsSharedIf true, the credentials used for the connection are available for use by users who have been shared the connection.

A universal object identifier, which is unique across instances of the platform.

This internal identifier is particularly useful when create import mapping rules.


If set to false, type inferencing has been disabled for this connection. The default is true.

When type inferencing has been disabled, the Designer Cloud Powered by Trifacta platform does not apply Alteryx types to data when it is imported. For more information, see Configure Type Inference.

createdAtTimestamp for when the connection was made
updatedAtTimestamp for when the connection was last updated

If present, these values are the credentials used to connect to the database.

creator.idInternal identifier of the user who created the connection.
updater.idInternal identifier of the user who last updated the connection.
workspace.idInternal identifier of the workspace with which this connection is associated.

This page has no comments.