skip to main content
Hybrid Data Pipeline API reference : Administrators API : CORS Whitelist API : Get information on a trusted origin
  

Try Now
Get information on a trusted origin

Purpose

Retrieve information on a trusted origin for a CORS whitelist.

URL

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

Method

GET

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 following {id} parameter is required in the URL.
Parameter
Description
Valid Values
{id}
The ID of the trusted origin.
An unique ID that is generated when a trusted origin is added to the CORS whitelist.

Response Payload Definition

The response payload takes the following format.
{
"id": trusted_origin_id,
"domain": "trusted_origin_domain",
"description": "domain_description",
"lastModifiedBy": "username",
"lastModifiedTime": "timestamp"
}
Property
Description
Valid Values
"id"
The ID of the trusted origin.
An unique ID that is generated when a trusted origin is added to the CORS whitelist.
"domain"
The domain of the trusted origin.
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.
A user provided description of the trusted origin.
"lastModifiedBy"
The name of the administrator who last modified the entry of the trusted origin.
The Hybrid Data Pipeline username of the administrator.
"lastModifiedTime"
The last time the entry of the trusted origin was modified.
A timestamp.

Sample Server Success Response


Status code: 200
Successful response
{
"id": 1,
"domain": "http://*.abc.com",
"description": "The ABC group domain",
"lastModifiedBy": "Admin1",
"lastModifiedTime": "2017-08-13T18:15:09.352Z"
}

Authentication

Basic Authentication using Login ID and Password

Authorization

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