Enable, Disable, or Delete a Rule
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/APICS/instances/{serviceId}/accessrules/{ruleName}
Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.
Request
- application/json
-
identityDomainId: string
Name of the identity domain for the API Platform Cloud Service account.
-
ruleName: string
Name of the rule to enable, disable or delete.
-
serviceId: string
Name of the API Platform Cloud Service instance.
Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.
-
Authorization: string
Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
object
Request Body
-
operation:
string
Type of operation to perform on the access rule. Valid values are:
update
(to disable or enable a rule) anddelete
(to delete a rule). -
status:
string
State of the access rule to update to. This attribute is required only when you disable or enable a rule. Valid values are
disable
orenable
.
Response
- application/json
200 Response
object
Response Body, Status 200
-
description:
string
The Description of the rule.
-
destination:
string
The destination to which traffic is allowed. Valid values include:
OTD
: The Oracle Traffic Director load balancerOTD_ADMIN_HOST
: The administration host for the Oracle Traffic Director load balancerWLS_ADMIN_SERVER
: The WebLogic Server Administration ServerWLS_ADMIN_HOST
: The administration host for WebLogic ServerWLS_MANAGED_SERVER
: A WebLogic Server Managed Server
-
ports:
string
The ports for the rule.
-
ruleName:
string
The name of the rule.
-
ruleType:
string
The type of the rule; one of:
DEFAULT
,SYSTEM
orUSER
. -
source:
string
The source from which traffic is allowed. Valid values include:
PUBLIC-INTERNET
: Any host on the internetOTD
: The Oracle Traffic Director load balancerOTD_ADMIN_HOST
: The administration host for the Oracle Traffic Director load balancerWLS_ADMIN_SERVER
: The WebLogic Server Administration ServerWLS_MANAGED_SERVER
: A WebLogic Server Managed ServerDB
: The database specified when the API Platform Cloud Service instance was created.- A single IP address or a comma-separated list of subnets (in CIDR format) or IPv4 addresses.
-
status:
string
The status of the rule; one of:
disabled
orenabled
.
202 Response
object
Response Body, Status 202
-
rule:
object rule Object
Title:
rule Object
object
rule Object
-
description:
string
The Description of the rule.
-
destination:
string
The destination to which traffic is allowed. Valid values include:
OTD
: The Oracle Traffic Director load balancerOTD_ADMIN_HOST
: The administration host for the Oracle Traffic Director load balancerWLS_ADMIN_SERVER
: The WebLogic Server Administration ServerWLS_ADMIN_HOST
: The administration host for WebLogic ServerWLS_MANAGED_SERVER
: A WebLogic Server Managed Server
-
ports:
string
The ports for the rule.
-
ruleName:
string
The name of the rule.
-
ruleType:
string
The type of the rule; one of:
DEFAULT
,SYSTEM
orUSER
. -
source:
string
The source from which traffic is allowed. Valid values include:
PUBLIC-INTERNET
: Any host on the internetOTD
: The Oracle Traffic Director load balancerOTD_ADMIN_HOST
: The administration host for the Oracle Traffic Director load balancerWLS_ADMIN_SERVER
: The WebLogic Server Administration ServerWLS_MANAGED_SERVER
: A WebLogic Server Managed ServerDB
: The database specified when the API Platform Cloud Service instance was created.- A single IP address or a comma-separated list of subnets (in CIDR format) or IPv4 addresses.
-
status:
string
The status of the rule; one of:
disabled
orenabled
.
Examples
The following example shows how to update (disable) an access rule by submitting a PUT request on the REST resource using cURL. For more information about cURL, see cURL Examples
curl -i -X PUT -u apicsadmin:password -H "Content-Type: application/json" -d @accessrule.json https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/testsundBackup/accessrules/my_corp_vnc
Example of Request Body
The following shows an example of the request body to disable an access rule, in JSON format.
{ "operation":"update", "status":"disabled" }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Thu, 01 Dec 2016 18:25:51 GMT Transfer-Encoding: chunked Content-Type: application/json X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000010ef7 X-Frame-Options: DENY Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD Access-Control-Allow-Headers: Content-Type, api_key, Authorization Access-Control-Allow-Origin: *
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ruleName": "my_corp_vnc", "description": "corporate to VNC to Admin Server", "status": "disabled", "source": "192.168.0.1/32", "destination": "WLS_ADMIN_SERVER", "ports": "5900", "protocol": "tcp", "ruleType": "USER" }