Using API to add IPs to your IP allowlist - Cloud

Talend Cloud Management Console User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend Management Console
Content
Administration and Monitoring > Managing projects
Administration and Monitoring > Managing users
Deployment > Deploying > Executing Pipelines
Deployment > Deploying > Executing Tasks
Deployment > Scheduling > Scheduling Tasks

Use the POST method on the /v1/management/ip-allowlist/ips endpoint to add IPs to your IP allowlist.

In this example, Talend API Tester is used to issue API queries. For further information about Talend API Tester, see Talend Cloud API Tester User Guide.

Before you begin

Prerequisites: your IP allowlist must already exist. If not, create it using the POST method on the /v1/management/ip-allowlist endpoint as presented in the previous section. All the available endpoints are explained in the following section.

Procedure

  1. If you do not have a personal access token yet in the Users tab, generate a personal access token for your account:
    1. In the top-right corner, click your user name.
    2. Click Profile preferences > Personal access tokens > Add token.
    3. Enter a token name and click Generate.
  2. In the field next to the Method drop-down list, enter the IP allowlist endpoint to be used: https://api.<your_environment>.cloud.talend.com/v1/management/ip-allowlist/ips
    For example, your environment could be:
    • ap
    • eu
    • us
    • us-west
    • au

    For more details about the available environments, see Talend Cloud regions and URLs.

  3. In the HEADERS area, click Add header and in the name field that is displayed, enter Authorization and in the value field, enterBearer and your personal access token. Enter a whitespace to separate Bearer and your personal access token.
  4. In the Body area, enter the following IPs:

    Example

    [
      {
        "description": "Data Prep user1",
        "ip": "230.65.223.167"
      },
      {
    	"description": "Data Prep user2",
        "ip": "230.65.223.169"
      }
    ]
  5. Click Send to issue your request.

Results

The status code 201 is returned and the IPs are added to your IP allowlist successfully.
Alternatively, you can execute a curl command in your command-line tool to perform the same operation.
curl -X POST "https://api.<your_environment>.cloud.talend.com/v1/management/ip-allowlist/ips" -H "accept: */*" -H "Authorization: Bearer <your_access_token>" -H "Content-Type: application/json" -d "[ { \"description\": \"Data Prep user1\", \"ip\": \"230.65.223.167\" }, {\t\"description\": \"Data Prep user2\", \"ip\": \"230.65.223.169\" }]"