Page tree

 

This is the latest version of the APIs.

Contents:


Modify the specified connection.

For more information on connections, see Connection Types.

Version:  v4

Required Permissions

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: PATCH

Endpoint:

/v4/connections/<id>

where:

ParameterDescription
<id>Internal identifier for the connection

Request URI - Example:

/v4/connections/8

Request Body:

Only the properties that are being modified need to be included in the request. In the following example, the default database and the description of the connection are modified:

{
  "params": {
     "defaultDatabase": "my_default_db"
  },
  "description": "This connection uses a non-default default DB."
}

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "id": 8,
    "updater": {
        "id": 1
    },
    "updatedAt": "2019-01-25T23:19:27.648Z"
}

Reference

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

This page has no comments.