skip to main content
Hybrid Data Pipeline API reference : IP Address Whitelist API
  

Try Now

IP Address Whitelist API

You can use the IP Address Whitelist API to create an IP address whitelist to determine which IP addresses (either individual IP addresses or a range of IP addresses) can access resources such as the Management API, the Administrators API, data access, and the Web UI. Depending on a user's permissions, IP address whitelists can be implemented at system, tenant, and user levels. (See Implementing IP address whitelists for additional details.)
*A user with the Administrator (12) permission (a system administrator) can implement and create whitelists for all resources at system, tenant and user levels.
*A user with the following permissions can create whitelists for resources at the tenant level: the MgmtAPI (11) permission, the IPWhiteList (29) permission, and administrative access to the tenant.
*A user with the following permissions can create whitelists for resources at the user level: the Mgmt (11) permission and the IPWhitelist (29) permission.
Note:
*IP address whitelists are enabled by default. Unless you have disabled this feature, any IP address whitelist you create will immediately be enforced. For how to enable or disable IP address whitelists, see Enabling and disabling the IP address whitelist feature.
*In the event that an IP address whitelist implementation inadvertently prevents administrators from using Hybrid Data Pipeline, an administrator can bypass the whitelist by accessing the service directly from any machine hosting the service. First, the administrator must have access privileges to the host machine. Next, the administrator can access the service from a host machine by replacing the servername in the Hybrid Data Pipeline URL with localhost, 127.0.0.1, or ::1. Then, the administrator can disable the IP address whitelist feature or update the implementation as desired.
You can perform the following operations with the IP Address Whitelist API.
Operation
Request
URL
GET
https://<myserver>:<port>/api/admin/security/whitelist/system
PUT
https://<myserver>:<port>/api/admin/security/whitelist/system
POST
https://<myserver>:<port>/api/admin/security/whitelist/system
DELETE
https://<myserver>:<port>/api/admin/security/whitelist/system
GET
https://<myserver>:<port>/api/admin/security/whitelist/tenants
GET
https://<myserver>:<port>/api/admin/security/whitelist/tenants/{id}
PUT
https://<myserver>:<port>/api/admin/security/whitelist/tenants/{id}
POST
https://<myserver>:<port>/api/admin/security/whitelist/tenants/{id}
DELETE
https://<myserver>:<port>/api/admin/security/whitelist/tenants/{id}
GET
https://<myserver>:<port>/api/admin/security/whitelist/users
GET
https://<myserver>:<port>/api/mgmt/security/whitelist/user?user=<user_name>
POST
https://<myserver>:<port>/api/mgmt/security/whitelist/user?user=<user_name>
PUT
https://<myserver>:<port>/api/mgmt/security/whitelist/user?user=<user_name>
DELETE
https://<myserver>:<port>/api/mgmt/security/whitelist/user?user=<user_name>
* Retrieve IP address whitelists at the system level
* Create IP address whitelists at the system level
* Update IP address whitelists at the system level
* Delete IP address whitelists at the system level
* Retrieve tenants configured with IP address whitelists
* Retrieve IP address whitelists for a tenant
* Create IP address whitelists for a tenant
* Update IP address whitelists for a tenant
* Delete IP address whitelists for a tenant
* Retrieve users configured with IP address whitelist
* Retrieve IP address whitelists for a user
* Create IP address whitelists for a user
* Update IP address whitelists for a user
* Delete IP address whitelists for a user