Connections
Manage the connections used by the datasets.
- Contact
- Talend
Endpoints
- https://api.eu.cloud.talend.comURL for the AWS Europe region
- https://api.ap.cloud.talend.comURL for the AWS Asia Pacific region
- https://api.us.cloud.talend.comURL for the AWS United States East region
- https://api.au.cloud.talend.comURL for the AWS Australia region
- https://api.us-west.cloud.talend.comURL for the Azure United States West region
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.
| Name | Description |
|---|---|
| Format | Bearer <token> |
Get the list of connections
GET /connectionsUse this method to list all the connections that have been created for a given user account.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| tqlQuery | Filter on dataset’s list by using TQL | string Optional |
Response
200Status 200
successful operation
Body
application/json
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| array of ConnectionListView |
| |||||||||||
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
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required |
Response
Get a connection
GET /connections/{connectionId}Use this method to get information on a given connection based on its id.
Request
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| connectionId | string Required |
Response
ConnectionListView
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | UUID | string Optional | 61333e88-a7d3-4ee7-bdb9-17c622636c4b | |||||||||
| label | Display name of the connection | string Required | MySQL Connection 1 | |||||||||
| type | Identifier for the type of the connection | string Required | amRiYy1lZSNKZGJjI2RhdGFzdG9yZSNKZGJjQ29ubmVjdGlvbg | |||||||||
| typeLabel | Label for the connection type | string Optional | JDBC | |||||||||
| cloudAgentId | ID of the engine configured for this connection | string Optional | 51b19d72-42cc-4507-96ad-533703bcc140 | |||||||||
| datasetsCount | Number of datasets using this connection | integer Required | INT32 2 | |||||||||
| entitlements | array of string Optional |
| ||||||||||
| icon | Icon identifier for this connection, for the user interface display | string Optional | flow-o | |||||||||
| sharing | SharingState Required | |||||||||||
| tags | array of string Optional |
| ||||||||||
| created | Timestamp of the creation | datetime Required | RFC3339 | |||||||||
| updated | Timestamp of the last update | datetime Required | RFC3339 | |||||||||
| createdBy | ID of the user who created this connection | string Optional | ||||||||||
| updatedBy | ID of the user who updated in last this connection | string Optional |
ConnectionResponse
Object
| Name | Description | Type | Attributes and examples | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | UUID | string Optional | 61333e88-a7d3-4ee7-bdb9-17c622636c4b | |||||||||
| label | Display name for the connection | string Required | MySQL Connection 1 | |||||||||
| description | Description of the connection | string Optional | 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 | bG9jYWxpbyNMb2NhbElPI2RhdGFzdG9yZSNGaXhlZERhdGFTdG9yZUNvbmZpZ3VyYXRpb24 | |||||||||
| typeLabel | Label for the type of the connection | string Optional | Google Cloud Storage | |||||||||
| cloudAgentId | Id of the engine configure for the connection | string Optional | ||||||||||
| datasetsCount | Number of datasets using the connection | integer Required | INT32 | |||||||||
| 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 | ||||||||||
| tags | array of string Optional |
| ||||||||||
| version | Technical version of this connection | integer Required | INT64 0 | |||||||||
| created | Timestamp of the creation for this connection | datetime Required | RFC3339 | |||||||||
| updated | Timestamp of the last update for this connection | datetime Required | RFC3339 | |||||||||
| createdBy | Id of the user who created the connection | string Optional | ||||||||||
| updatedBy | Id of the user who updated in last the connection | string Optional | ||||||||||
CommandSuccess
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| id | string Optional | ||
| requestId | string Optional |
SharingState
Object
| 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 |
ErrorMessageBody
Object
| Name | Description | Type | Attributes and examples |
|---|---|---|---|
| error | string Required | ||
| exception | string Optional | ||
| message | string Optional | ||
| path | string Required | ||
| status | integer Required | INT32 | |
| timestamp | integer Required | INT64 |