Purpose

Returns IP address whitelists for resources which are configured at the system level.

URL

https://<myserver>:<port>/api/admin/security/whitelist/system

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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.

Response Definition

{
  "managementAPI": [
    {
      "startAddress": "<start_ip_address>",
      "endAddress": "<end_ip_address>"
    }
  ],
  "adminAPI": [...],
  "dataAccess": [...],
  "webUI": [...]
}
Property Description Valid Values
"managementAPI" Individual IP addresses or a range of IP addresses that restrict access to the Management API. 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. 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. 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.
 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.

Sample Server Success Response 

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

Sample Server Failure Response 

{
  "error": {
    "code": 222208712,
    "message": "Problem getting WhiteList IPs at this time. Please try again at another time."
  }
}

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.