skip to main content
Hybrid Data Pipeline API reference : IP Address Whitelist API : Update IP address whitelists for a tenant
  

Try Now

Update IP address whitelists for a tenant

Purpose

Updates IP address whitelists for a tenant.

URL

https://<myserver>:<port>/api/admin/security/whitelist/tenants/{id}

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.
The URL parameter {id} described in the following table is required.
Parameter
Description
Valid Values
{id}
The ID of the tenant.
A valid tenant ID.

Request Payload Definition

The request takes the following format. The properties of the request are described in the table that follows.
{
"managementAPI": [
{
"startAddress": "<start_ip_address>",
"endAddress": "<end_ip_address>"
}
],
"adminAPI": [...],
"dataAccess": [...],
"webUI": [...]
}
Property
Description
Usage
Valid Values
"managementAPI"
Individual IP addresses or a range of IP addresses that restrict access to the Management API.
Optional
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.
"adminAPI"
Individual IP addresses or a range of IP addresses that restrict access to the Administrators API.
Optional
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.
"dataAccess"
Individual IP addresses or a range of IP addresses that restrict data access through JDBC, ODBC, and OData calls.
Optional
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.
"webUI"
Individual IP addresses or a range of IP addresses that restrict access to the Web UI.
Note: Can only be applied at the system level.
Optional
An array of JSON objects. Each object must be either a single IP address designated with the "startAddress" property, or a range of IP addresses designated with the "startAddress" and "endAddress" properties. IP addresses may be specified in either IPv4 or IPv6.

Request Payload Sample

Note: Optional properties not included in the payload request will be removed from the object.
{
"managementAPI": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.30.10"
}
],
"adminAPI": [],
"dataAccess": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.50.10"
}
],
"webUI": null
}

Sample Server Success Response

Status code: 200
Successful response
{
"managementAPI": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.30.10"
}
],
"adminAPI": [],
"dataAccess": [
{
"startAddress": "10.20.30.0",
"endAddress": "10.20.50.10"
}
],
"webUI": null
}

Sample Server Failure Response

{
"error": {
"code": 222208719,
"message": {
"lang": "en-US",
"value": "whiteList IPs does not exist for tenant id : {0}."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission, or the MgmtAPI (11) and IPWhiteList (29) permissions.