API Connections Get Status v3

Contents:

Expand all Collapse all

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 Status v4.

Contents:

Run a connection test for 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.4/index.html#section/Authentication.

Request

Request Type: GET

Endpoint:

/v3/connections/<id>/status

where:

Parameter	Description
`<id>`	Internal identifier for the connection

Request URI - Example:

/v3/connections/10/status

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "result": "SUCCESS",
  "reason": null
}

Reference

Property Description

result

Results of testing the connection.

For more information on debugging failures in relational connections, see Enable Relational Connections.
For more information on debugging Hive connections. see Configure for Hive.
For more information on debugging S3 connections, see Enable S3 Access.

reason If the result value is not SUCCESS, additional information may be included here.

Send Feedback

Page tree

API Connections Get Status v3

Required Permissions

Request

Response

Reference