Jump to

• Request
• Response

Update an Access Rule

put

/paas/api/v1.1/paas/api/v1.1/instancemgmt/{identityDomainId}/services/IntegrationCloud/instances/{service_name}/accessrules/{ruleName}

Disable, enable, or delete an access rule only. You cannot change the rule details.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Integration Classic account.
• ruleName: string
  Name of the access rule to disable or enable.
• service_name: string
  Name of the Oracle Integration Classic instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle Integration Classic account.

Body ()

The request body defines the details of the disable, enable, or delete request.

Root Schema : updatesecrule-putrequest

Type: object

Show Source

• operation: string
  Type of operation to perform on the access rule. Valid values are: update (to disable or enable a rule) and delete (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 value is disable or enable.

{
    "properties":{
        "operation":{
            "type":"string",
            "description":"Type of operation to perform on the access rule. Valid values are: <code>update</code> (to disable or enable a rule) and <code>delete</code> (to delete a rule)."
        },
        "status":{
            "type":"string",
            "description":"State of the access rule to update to. This attribute is required only when you disable or enable a rule. Valid value is <code>disable</code> or <code>enable</code>."
        }
    },
    "required":[
        "operation",
        "status"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK (enable or disable rule).

202 Response

Accepted (delete rule).

Body ()

Root Schema : updatesecrule-response

Type: object

Show Source

• description(optional): string
  Description of the rule.
• destination(optional): string
  The service component to allow traffic to.
• ports(optional): string
  Ports for the rule.
• rule(optional): string
  Groups information about rules. This attribute is returned when you delete a rule.
• ruleName(optional): string
  Name of the rule.
• ruleType(optional): string
  Type of rule.
• source(optional): string
  The hosts from which traffic is allowed.
• status(optional): string
  Status of the rule.

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the rule."
        },
        "destination":{
            "type":"string",
            "description":"The service component to allow traffic to."
        },
        "rule":{
            "type":"string",
            "description":"Groups information about rules. This attribute is returned when you delete a rule."
        },
        "ruleName":{
            "type":"string",
            "description":"Name of the rule."
        },
        "ruleType":{
            "type":"string",
            "description":"Type of rule."
        },
        "ports":{
            "type":"string",
            "description":"Ports for the rule."
        },
        "source":{
            "type":"string",
            "description":"The hosts from which traffic is allowed."
        },
        "status":{
            "type":"string",
            "description":"Status of the rule."
        }
    }
}

Back to Top