The IP allowlist API endpoints - Cloud

Talend Cloud Management Console for Pipelines User Guide

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Administration and Monitoring > Managing projects
Administration and Monitoring > Managing users
Deployment > Deploying > Executing Tasks
Deployment > Scheduling > Scheduling Tasks
EnrichPlatform
Talend Management Console

The host to be used to access this API is: https://api.<env>.cloud.talend.com.

For the complete API documentation of this API, see https://api.<env>.cloud.talend.com/v1/management/swagger-ui.html and select IP Allowlist Management from the Select a spec drop-down list.

The <env> part is the name of your Cloud region. If you do not know what your region name is, see Talend Cloud regions and URLs.

You must use your access token to call the API. For further information about how to generate an access token and how to use this token, see Generating a Personal Access Token.

Operations Methods Resources Required permissions
Retrieving the configuration of your IP allowlist policy, such as the IPs on the list, whether this policy has been enabled GET

/v1/management/ip-allowlist

Users - Management
Setting up the entire configuration of your IP allowlist policy. With this request, you create an IP allowlist with or without adding IPs and define whether to activate your IP allowlist policy at the same time.

Note that once your IP allowlist policy is activated, only the IPs on your allowlist is allowed to access Talend Cloud.

POST /v1/management/ip-allowlist Users - Management
Updating the configuration of your IP allowlist policy. With this request, you add IPs to the existing IP allowlist and activate or deactivate your IP allowlist policy at the same time.

Note that once your IP allowlist policy is activated, only the IPs on your allowlist is allowed to access Talend Cloud.

PUT /v1/management/ip-allowlist Users - Management
Deleting your IP allowlist policy. DELETE /v1/management/ip-allowlist Users - Management
Activating or deactivating your IP allowlist policy. PATCH /v1/management/ip-allowlist Users - Management
Retrieving all the IPs from your IP allowlist. GET /v1/management/ip-allowlist/ips Users - Management
Adding new IPs to the IP allowlist. POST /v1/management/ip-allowlist/ips Users - Management
Updating a set of IPs on your IP allowlist. You need to provide the IDs of the IPs to be updated in your request. PUT /v1/management/ip-allowlist/ips Users - Management
Retrieving a specific IP by its ID on the IP allowlist. GET /v1/management/ip-allowlist/ips/<ip_entry_id> Users - Management
Finding an IP on your IP allowlist by its ID and updating this IP with the new address your provide in your request PUT /v1/management/ip-allowlist/ips/<ip_entry_id> Users - Management
Deleting a specific ID from your IP allowlist. DELETE /v1/management/ip-allowlist/ips/<ip_entry_id> Users - Management