Latest version of this endpoint: API Connections Get v4.
Contents:
Get the specified connection.
For more information on connections, see CLI for Connections.
Version: v3
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.0/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v3/connections/<id>
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the connection |
Request URI - Example:
/v3/connections/3
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"data": [
{
"connectParams": {
"vendor": "postgres",
"host": "localhost",
"port": "5432",
"database": "trifacta"
},
"id": 10,
"host": "localhost",
"port": 5432,
"vendor": "postgres",
"params": {
"connectStrOpts": "",
"database": "trifacta"
},
"ssl": false,
"name": "postgres",
"description": "",
"type": "jdbc",
"createdBy": 1,
"isGlobal": false,
"credentialType": "basic",
"credentialsShared": true,
"uuid": "7d173c90-c4e1-11e7-a768-71cd1fa636c3",
"createdAt": "2017-11-09T00:04:00.345Z",
"updatedAt": "2017-11-09T00:04:00.345Z",
"updatedBy": 1,
"credentials": [
{
"username": "<userId>"
}
]
},
{
"connectParams": {
"vendor": "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,
"name": "hive",
"description": null,
"type": "jdbc",
"createdBy": 1,
"isGlobal": true,
"credentialType": "conf",
"credentialsShared": true,
"uuid": "ae41c5a0-c460-11e7-8163-c3c02bb1fb0b",
"createdAt": "2017-11-08T08:41:57.755Z",
"updatedAt": "2017-11-08T08:41:57.755Z",
"updatedBy": 1,
"credentials": []
}
],
"count": {
"owned": 2,
"shared": 0,
"count": 2
}
}
Reference
| Property | Description |
|---|---|
| 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. |
| ssl | When |
| 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 |
| isGlobal | If NOTE: After a connection has been made public, it cannot be made private again. It must be deleted and recreated. Default is |
| credentialType | The type of credentials used for the connection. This value varies depending on where the credentials are stored. See CLI for Connections. |
| credentialsShared | If true, the credentials used for the connection are available for use by users who have been shared the connection. |
| uuid | 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 |
| credentials | 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 node, after which they do not appear in this setting. See CLI for Connections. |
This page has no comments.