Get Email Domain Allowlist (v2)

Use this REST API to retrieve the configured list of allowed email domains to which emails can be sent from the EPM Cloud environment. If this list is not empty, emails will not be sent to any address whose domain is not one of the returned email domains.

Required Roles

Service Administrator

REST Resource

POST /interop/rest/v2/mails/allowlist

Request

Supported Media Types: application/json

Response

Table 2-185 Parameters

Name	Description
details	In the case of errors, details are published with the error string
status	See Migration Status Codes
items	Detailed information about the API
alloweddomains	Lists the allowed domains
links	Detailed information about the link
href	Links to API call
action	The HTTP call type
rel	Possible values: self
data	Parameters as key value pairs passed in the request

Example Response with Non-Empty List of Allowed Email Domains

{
    "details": null,
    "status": 0,
    "items": [{
        "alloweddomains": "example.com,oracle.com"
    }],
    "links": [{
            "href": "https://<BASE-URL>/interop/rest/v2/mails/allowlist",
            "action": "GET",
            "rel": "self",
            "data": null
    }]
}

Example Response with Empty Allowed Email Domain List

{
  "details": null,
  "status": 0,
  "items": [
    {
      "alloweddomains": ""
    }
  ],
  "links": [
    {
      "href": "https://<BASE-URL>/interop/rest/v2/mails/allowlist",
      "action": "GET",
      "rel": "self",
      "data": null
    }
  ]
}

Sample cURL Command

curl -X GET -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json'  'https://<BASE-URL>/interop/rest/v2/mails/allowlist'