REST API for Oracle Enterprise Performance Management Cloud

Use the POST method with the action parameter set to add to add the IP addresses and Classless Inter-Domain Routings (CIDRs) to the allowlist of your environment.

Use the POST method with the action parameter set to remove to remove the IP addresses and CIDRs from the allowlist of your environment.

This REST API is version v2.

Required Roles

Service Administrator

REST Resource

POST /interop/rest/epmociservice/v2/ipallowlist

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Request

Supported Media Types: application/json

The following table summarizes the POST request parameters.

Table 10-22 Parameters

Name Description Type Required Default

Name	Description	Type	Required	Default
`fileName`	The path to a filename with a list of IP addresses and CIDRs that you want to add to or remove from the allowlist. If you want the file to be uploaded to the default location, the path is not required and you only need to specify the file name. Example: `IPList.txt` Each line in the file must be an IP address or CIDR in the following format: `xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx/n` Note: Only IP V4 IP addresses are supported. Use CIDR format, rather than individual IP addresses, to specify a continuous range of IP addresses.	Payload	Yes	None
`action`	Use `add` to add IP addresses and CIDRs to the allowlist of your environment. Use `remove` to remove IP addresses and CIDRs from the allowlist.	Payload	Yes	None

fileName

The path to a filename with a list of IP addresses and CIDRs that you want to add to or remove from the allowlist.

If you want the file to be uploaded to the default location, the path is not required and you only need to specify the file name.

Example: IPList.txt

Each line in the file must be an IP address or CIDR in the following format:

xxx.xxx.xxx.xxx
xxx.xxx.xxx.xxx/n

Note:

Only IP V4 IP addresses are supported.
Use CIDR format, rather than individual IP addresses, to specify a continuous range of IP addresses.

Payload

Yes

None

action

Use add to add IP addresses and CIDRs to the allowlist of your environment.

Use remove to remove IP addresses and CIDRs from the allowlist.

Payload

Yes

None

Examples of the Request Body

Example 1: Add to the IP allow list

{
    "fileName" : "IPList.txt",
    "action" : "add"
}

Example 2: Remove from the IP allow list

{
    "fileName" : "IPList.txt",
    "action" : "remove"
}

Response

Supported Media Types: application/json

Table 10-23 Parameters

Name	Description
`details`	In the case of errors, details are published with the error string
`status`	See Migration Status Codes
`links`	Detailed information about the link
`href`	Links to API call or status API
`action`	The HTTP call type
`rel`	Possible values: `self` or `Job Status`. If the value is set to `Job Status`, you can use the href to get the status of the copy snapshot

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "links": [
        {
            "rel": "self",
            "href": "http://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/epmociservice/v2/ipallowlist",
            "data": null,
            "action": "POST"
        },
        {
            "rel": "Job Status",
            "href": "http://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/epmociservice/v2/status/jobs/2126145698194859",
            "data": null,
            "action": "GET"
        }
    ],
    "details": null,
    "status": -1,
    "items": null
}

Common Functions