Page tree

Release 6.4.2


Contents:

   

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

As of Release 6.4, the v3 APIs are End of Life (EOL). Before using this release or a later one, you should migrate to using the latest available API version. For more information, see API Version Support Matrix.
Latest version of this endpoint: API Connections Get List v4.

Contents:


Get the list of accessible connections for the authenticated user.

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.4/index.html#section/Authentication.

Request

Request Type: GET

Endpoint:

/v3/connections

Endpoint with paged retrieval:


By default, this endpoint returns results in sets of 25. 

You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:

/v3/connections?limit=100&offset=2

If the count of retrieved results is less than the limit, you have reached the end of the results.

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "data": [
    {
      "connectString": "jdbc:postgresql://localhost:5432/trifacta?ssl=true",
      "id": 9,
      "host": "localhost",
      "port": 5432,
      "vendor": "postgres",
      "params": {
        "database": "trifacta"
      },
      "ssl": true,
      "name": "dc31bef0_e7ea_11e6_8c19_4f07370e0072",
      "description": null,
      "type": "jdbc",
      "createdBy": 2,
      "isGlobal": false,
      "credentialType": "basic",
      "createdAt": "2017-01-31T19:24:37.167Z",
      "updatedAt": "2017-01-31T19:24:37.167Z",
      "updatedBy": 2,
      "credentials": [
        {
          "username": "trifacta"
        }
      ]
    },
    {
      "connectString": "jdbc:postgresql://does-not-exist:5432/trifacta",
      "id": 7,
      "host": "does-not-exist",
      "port": 5432,
      "vendor": "postgres",
      "params": {
        "database": "trifacta"
      },
      "ssl": false,
      "name": "dc3197e0_e7ea_11e6_8c19_4f07370e0072",
      "description": null,
      "type": "jdbc",
      "createdBy": 2,
      "isGlobal": false,
      "credentialType": "basic",
      "createdAt": "2017-01-31T19:24:31.899Z",
      "updatedAt": "2017-01-31T19:24:31.899Z",
      "updatedBy": 2,
      "credentials": [
        {
          "username": "trifacta"
        }
      ]
    }
  ]
}

Reference

For more information on the properties of a connection, see API Connections Get v3.

This page has no comments.