Update the IP Allowlist - Only for OCI (Gen 2) Environments
In OCI (Gen 2) environments, you can use a REST API to update the IP allowlist.
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 |
---|---|---|---|---|
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: Each line in the file must be an IP address or CIDR in the following format:
Note:
|
Payload | Yes | None |
action |
Use Use |
Payload | Yes | None |
Examples of Request Body
Example 1: Add to the IP Allow List
{
"fileName" : "IPList.txt",
"action" : "add"
}
Example 2: Remove from the IP Allow lLst
{
"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://<BASE-URL>interop/rest/epmociservice/v2/ipallowlist",
"data": null,
"action": "POST"
},
{
"rel": "Job Status",
"href": "http://<BASE-URL>/interop/rest/epmociservice/v2/status/jobs/2126145698194859",
"data": null,
"action": "GET"
}
],
"details": null,
"status": -1,
"items": null
}