Get the specified connection.
For more information on connections, see CLI for Connections.
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/5.0/index.html#section/Authentication.
|Internal identifier for the connection|
Request URI - Example:
Response Status Code - Success:
200 - OK
Response Body Example:
|connectParams.vendor||The type of connection. See Connection Types.|
|connectParams.host||Host of the source|
|connectParams.port||Port number for the source|
|connectParams.database||Name of the default database (if applicable)|
|id||Internal identifier for the connection|
|host||Host of the source|
|port||Port number for the source|
|vendor||String identifying the connection's vendor|
|params||This 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.|
|name||Internal name of the connection|
|description||User-friendly description for the connection|
|type||Type of connection|
|createdBy||Internal identifier for the user who created the connection|
NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated.
|credentialType||The type of credentials used for the connection. This value varies depending on where the credentials are stored. See CLI for Connections.|
A universal object identifier, which is unique across instances of the platform.
This internal identifier is particularly useful when create import mapping rules.
|createdAt||Timestamp for when the connection was made|
|updatedAt||Timestamp for when the connection was last updated|
|updatedBy||Internal identifier for the user who last updated the connection|
If present, these values are the credentials used to connect to the database.
NOTE: For security reasons, you can store the connection's credentials in an external file on the Alteryx Server, after which they do not appear in this setting. See CLI for Connections.
This page has no comments.