Talend Cloud Management Console Public APIs - Cloud

Talend Cloud Management Console for Pipelines User Guide
Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend Pipeline Designer
Content
Administration and Monitoring > Managing projects
Administration and Monitoring > Managing users
Deployment > Deploying > Executing Tasks
Deployment > Scheduling > Scheduling Tasks

You can use various APIs to interact with Talend Cloud Management Console from an external system such as a scheduler or an API query tool.

The Talend Cloud Management Console UI API allows you to perform management operations without having to open the specific Talend Cloud Management Console pages.

This API is hosted at https://api.<env>.cloud.talend.com/tmc/, where <env> is the name of your Cloud region, for example, https://api.us.cloud.talend.com/tmc/ for AWS USA or https://api.eu.cloud.talend.com/tmc/ for AWS Europe. For further details about the available regions, see Talend Cloud regions and URLs.

Restriction: The same task or plan can only be in the execution queue (in Pending or Running status) maximum 50 times in a 60-minute time period. If you have scheduled a task or plan through the public API or a webhook to run more times than that, any new execution that would be added to the queue will fail after the limit is reached.
In addition to this Talend Cloud Management Console UI API, depending on your license, the following APIs could be available:
  • Audit logging API
  • IP allowlist

To use these APIs, you must authenticate your calls using a Bearer Personal Access Token that you can generate from your profile preferences.

For further information about the available APIs and related use cases, see Talend Cloud APIs User Guide.

Public API lifecycle

The API is updated when a new feature is delivered, which may happen outside of the Talend Cloud release cycle.

Versioning:
  • The first digit is increased when an update breaks compatibility or in case a marketing release is rolled out.
  • The second digit is increased when a new feature is introduced without breaking changes, while keeping the compatibility.

Patches: Patches are not delivered for API versions; each update introduces a new version. New features are not ported back to earlier versions.

Support: Once a version is released, it is supported for next 18 months.