Setting up your IP allowlist without activating it

Call the /security/ip-allowlist endpoint to set up your IP allowlist and keep this list inactive.

Use the POST method on the /security/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.

Before you begin

  • Generate an access token:
    • For users, generate a personal access token. For further information, see Generating a Personal Access Token.
    • For service accounts, generate a service account token. For further information about how to generate a service account token, see Generating a service account token. Once generated, a service account token expires after 30 minutes. If it expires, generate a new token using the POST method at the endpoint https://api.{env}.cloud.talend.com/security/oauth/token.

Procedure

  1. Open Talend API Tester in your browser and select POST from the Method list.
  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/security/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.

  1. In the HEADERS area, click Add header and in the name field that is displayed, enter Authorization and in the value field, enter Bearer and your personal access token. Enter a whitespace to separate Bearer and your personal access token.
  2. 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"
    }
  ]
}

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.

Next section: Adding IPs to your IP allowlist