Purpose

Creates a CORS whitelist or adds trusted origins to a CORS whitelist. The whitelist is an array of JSON objects. Each object, or entry, provides details for each trusted origin.

URL

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

Method

POST

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.

Request Definition

{
  "whitelist": [
    {
      "domain": "trusted_origin_domain",
      "description": "domain_description"
    },
    ...
  ]
}
Property Description Usage Valid Values
"domain" The domain of the trusted origin. Required A valid domain for the trusted origin. For example, https://abc.com.

The wild card * can be used at the beginning of a domain. For example, *.progress.com is a valid entry, and will whitelist any origin that ends with progress.com. The wild card is not supported at any other location within a domain. For example, progress.abc.*.com is not supported for origin validation.
"description" A description of the trusted origin. Optional A user provided description of the trusted origin.

Sample Request Payload

    {
      "whitelist": [
          {
             "domain": "http://*.abc.com",
             "description": "The ABC group domain"
          },
          {
             "domain": "http://bar.test.com",
             "description": "The bar trusted origin"
          }
       ]
    }

Sample Server Success Response 

    Status code: 201
    Successful response
    {
      "whitelist": [
          {
             "domain": "http://*.abc.com",
             "description": "The ABC group domain"
          },
          {
             "domain": "http://bar.test.com",
             "description": "The bar trusted origin"
          }
       ]
    }

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) or the CORSwhitelist (23) permission.