Connections

Manage the connections used by the datasets.

Contact: Talend

Endpoints

https://api.eu.cloud.talend.com
URL for the AWS Europe region
https://api.ap.cloud.talend.com
URL for the AWS Asia Pacific region
https://api.us.cloud.talend.com
URL for the AWS United States East region
https://api.au.cloud.talend.com
URL for the AWS Australia region
https://api.us-west.cloud.talend.com
URL for the Azure United States West region

Global security

These security schemes apply to the entire API

Public

Security scheme

This scheme can be referenced across the API

Public

This Bearer authentication can be set in the Authorization header of your requests.

Authentication tokens and Personal Access Tokens are supported.

Personal Access Tokens can be generated in the Profile Preferences page of the Talend Cloud Portal.

Bearer authentication
Name	Description
Format	Bearer <token>

Get the list of connections

GET /connections

Use this method to list all the connections that have been created for a given user account.

Use cases

Creating a crawler from a JDBC connection

Request

Query parameters
Name	Description	Type	Attributes and examples
tqlQuery	Filter on dataset’s list by using TQL	string Optional

Response

200Status 200

successful operation

Body

array of ConnectionListView

Datatype details
Type	Description	Attributes and examples
array
ConnectionListView

401Status 401

Not authenticated

Body

ErrorMessageBody

403Status 403

Not Authorized

Body

ErrorMessageBody

500Status 500

Internal server error

Body

ErrorMessageBody

502Status 502

Bad gateway

Body

ErrorMessageBody

503Status 503

Service unavailable

Body

ErrorMessageBody

Delete a connection

DELETE /connections/{connectionId}

Use this method to delete a given connection based on its id. You cannot delete connections with existing datasets based on it. The datasets must be deleted first.

Request

Path variables
Name	Description	Type	Attributes and examples
connectionId		string Required

Response

200Status 200

successful operation

Body

CommandSuccess

401Status 401

Not authenticated

Body

ErrorMessageBody

403Status 403

Not Authorized

Body

ErrorMessageBody

500Status 500

Internal server error

Body

ErrorMessageBody

502Status 502

Bad gateway

Body

ErrorMessageBody

503Status 503

Service unavailable

Body

ErrorMessageBody

Get a connection

GET /connections/{connectionId}

Use this method to get information on a given connection based on its id.

Request

Path variables
Name	Description	Type	Attributes and examples
connectionId		string Required

Response

200Status 200

successful operation

Body

ConnectionResponse

400Status 400

Bad request

Body

ErrorMessageBody

401Status 401

Not authenticated

Body

ErrorMessageBody

403Status 403

Not Authorized

Body

ErrorMessageBody

404Status 404

Dataset not found

Body

ErrorMessageBody

500Status 500

Internal server error

Body

ErrorMessageBody

502Status 502

Bad gateway

Body

ErrorMessageBody

503Status 503

Service unavailable

Body

ErrorMessageBody

Object

UUID

string Optional

Example

61333e88-a7d3-4ee7-bdb9-17c622636c4b

label

Display name of the connection

string Required

Example

MySQL Connection 1

type

Identifier for the type of the connection

string Required

Example

amRiYy1lZSNKZGJjI2RhdGFzdG9yZSNKZGJjQ29ubmVjdGlvbg

typeLabel

Label for the connection type

string Optional

Example

JDBC

cloudAgentId

ID of the engine configured for this connection

string Optional

Example

51b19d72-42cc-4507-96ad-533703bcc140

datasetsCount

Number of datasets using this connection

integer Required

FormatINT32

Example

entitlements

array of string Optional

Datatype details
Type	Description	Attributes and examples
array	Intersection of TMC user entitlements and the user sharing entitlements
string		Example CONNECTION_READ

icon

Icon identifier for this connection, for the user interface display

string Optional

Example

flow-o

sharing

SharingState Required

tags

array of string Optional

Datatype details
Type	Description	Attributes and examples
array	List of tags set on this connection
string

created

Timestamp of the creation

datetime Required

FormatRFC3339

updated

Timestamp of the last update

datetime Required

FormatRFC3339

createdBy

ID of the user who created this connection

string Optional

updatedBy

ID of the user who updated in last this connection

string Optional

Object

UUID

string Optional

Example

61333e88-a7d3-4ee7-bdb9-17c622636c4b

label

Display name for the connection

string Required

Example

MySQL Connection 1

description

Description of the connection

string Optional

Example

Connection for the production database

enabled

Indicates if this connection is enabled or not

boolean Required

type

Id for the type of the connection

string Required

Example

bG9jYWxpbyNMb2NhbElPI2RhdGFzdG9yZSNGaXhlZERhdGFTdG9yZUNvbmZpZ3VyYXRpb24

typeLabel

Label for the type of the connection

string Optional

Example

Google Cloud Storage

cloudAgentId

Id of the engine configure for the connection

string Optional

datasetsCount

Number of datasets using the connection

integer Required

FormatINT32

familyId

string Optional

icon

Id of the icon used to display this connection

string Optional

owner

ID of the user who owns this connection

string Required

properties

Configuration for this connection

ObjectRequired

Name	Description	Type	Attributes and examples
isOwner	Indicates if the current user is owner of the resource	boolean Required
isSharedWithOthers	Indicates if the resource is shared with other users or groups	boolean Required

Name	Type	Attributes and examples
error	string Required
exception	string Optional
message	string Optional
path	string Required
status	integer Required	FormatINT32
timestamp	integer Required	FormatINT64