API Connections Get Status v3

D toc

Run a connection test for the specified connection.

For more information on connections, see CLI for Connections.

Version: v3

Required Permissions

D s api auth

Request Type: GET

Endpoint:

Code Block
/v3/connections/<id>/status

where:

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

Request URI - Example:

Code Block
/v3/connections/10/status

Request Body:

Empty.

Response Status Code - Success: 200 - OK

Response Body Example:

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

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.