Using API to set up your IP allowlist without activating it - Cloud

Talend Cloud Management Console User Guide
Version
Cloud
Language
English
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
Last publication date
2023-09-20

Use the POST method on the /v1/management/ip-allowlist endpoint to set up your IP allowlist with your IP and keep this list inactive.

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.

If you need information about other available endpoints, see the following section about the IP allowlist API endpoints.

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. Open Talend API Tester in your browser and select POST from the Method list.
  3. 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
    For example, your environment could be:
    • ap
    • eu
    • us
    • us-west
    • au
    • at if you are using this feature in an Early Adopter Program.

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

  4. 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.
  5. In the Body area, enter the following IPs:

    Example

    {
  "description": "description_of_your_IP_allowlist",
  "enabled": false,
  "ips": [
    {
      "description": "description_of_your_IP",
      "ip": "XXX.XX.XXX.XXX"
    }
  ]
}
  6. Click Send to issue your request.

Results

The status code 201 is returned and your IP allowlist is set up successfully with your IP on this list. But this allowlist is not activated as the enabled parameter was set to false in the query.