Getting Started with Talend Cloud APIs - Cloud

Talend Cloud APIs User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Design and Development > Designing APIs
Design and Development > Testing APIs

For this use case, you want to get all available Remote Engines with Talend Cloud Management Console REST API. You are using Talend Cloud API Tester.

Note: Make sure you have the appropriate rights set in Talend Cloud Management Console to perform the tasks you want.

Before you begin

  • Ensure that Talend Cloud API Tester Chrome extension is installed on your browser.
  • Make sure you have the appropriate rights to access Remote Engines.
    • For users, assign the pre-defined Infrastructure Administrator role or grant the TMC_CLUSTER_MANAGEMENT permission.
    • For service accounts, grant the TMC_CLUSTER_MANAGEMENT permission.
  • Generate access tokens:

About this task

In this section, the following API call is issued:
method: POST
endpoint: https://api.<env>.cloud.talend.com/tmc/v2.6/runtimes/remote-engines
headers: {
 "Content-Type": "application/json",
 "Authorization": "Bearer <access_token>"
}
It is implemented in Talend API Tester for demonstration purposes.

Procedure

  1. Open Talend Cloud API Tester.
  2. Click Add header.
  3. Enter Authorization in the name field and Bearer <access token> in the field value.
  4. From the Talend Cloud regions and URLs page and according to your Talend Cloud account location, select the link pointing to Talend Cloud Management Console API reference documentation.
  5. Find and expand the API documentation you are looking for. In this use case, the API that gets all available Remote Engines.
  6. Click Try it out at the bottom of documentation tab you just expanded to get information such as the request URL or the response body.
  7. In Talend Cloud API Tester, fill the required fields and select the GET method.
    Note: If you want to manually add a query parameter in the URL, the character ? separates the API endpoint from the first query parameter and the character & then separates each query parameter.
  8. Click Send.

Results

The response 200 informs you that the request was successful. You can now see the list of all available Remote Engines.