Jump to

• Request
• Response
• Examples

Enable, Disable or Delete a Rule

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/dbaas/instances/{serviceId}/accessrules/{ruleName}

Enable or disable any rule, or delete a user-created rule.

Request

Supported Media Types

• application/json

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• ruleName: string
  Name of the rule to enable, disable or delete.
• serviceId: string
  Name of the Database Classic Cloud Service instance.

Header Parameters

• Authorization: string
  Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
• X-ID-TENANT-NAME: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Body ()

Root Schema : Request Body

Type: object

Title: Request Body

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 disabled or enabled.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "required":[
        "operation",
        "status"
    ],
    "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>disabled</code> or <code>enabled</code>."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. This status code is returned when enabling or disabling a rule.

Body ()

Root Schema : Response Body, Status 200

Type: object

Title: Response Body, Status 200

Show Source

• description(optional): string
  The Description of the rule.
• destination(optional): string
  The value DB_1.
• ports(optional): string
  The ports for the rule.
• ruleName(optional): string
  The name of the rule.
• ruleType(optional): string
  The type of the rule; one of: DEFAULT, SYSTEM or USER.
• source(optional): string
  IP addresses and subnets from which traffic is allowed.
• status(optional): string
  The status of the rule; one of: disabled or enabled.

{
    "title":"Response Body, Status 200",
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The Description of the rule."
        },
        "destination":{
            "type":"string",
            "description":"The value <code>DB_1</code>."
        },
        "ports":{
            "type":"string",
            "description":"The ports for the rule."
        },
        "ruleName":{
            "type":"string",
            "description":"The name of the rule."
        },
        "ruleType":{
            "type":"string",
            "description":"The type of the rule; one of: <code>DEFAULT</code>, <code>SYSTEM</code> or <code>USER</code>."
        },
        "source":{
            "type":"string",
            "description":"IP addresses and subnets from which traffic is allowed."
        },
        "status":{
            "type":"string",
            "description":"The status of the rule; one of: <code>disabled</code> or <code>enabled</code>."
        }
    }
}

202 Response

Accepted. This status code is returned when deleting a rule.

Headers

• Location: string
  A REST URI you can use to check the progress and completion of the rule deletion operation.

Body ()

Root Schema : Response Body, Status 202

Type: object

Title: Response Body, Status 202

Show Source

• rule(optional): object rule Object
  Title: rule Object

{
    "title":"Response Body, Status 202",
    "type":"object",
    "properties":{
        "rule":{
            "title":"rule Object",
            "type":"object",
            "properties":{
                "description":{
                    "type":"string",
                    "description":"The Description of the rule."
                },
                "destination":{
                    "type":"string",
                    "description":"The value <code>DB_1</code>."
                },
                "ports":{
                    "type":"string",
                    "description":"The ports for the rule."
                },
                "ruleName":{
                    "type":"string",
                    "description":"The name of the rule."
                },
                "ruleType":{
                    "type":"string",
                    "description":"The type of the rule; one of: <code>DEFAULT</code>, <code>SYSTEM</code> or <code>USER</code>."
                },
                "source":{
                    "type":"string",
                    "description":"IP addresses and subnets from which traffic is allowed."
                },
                "status":{
                    "type":"string",
                    "description":"The status of the rule; one of: <code>disabled</code> or <code>enabled</code>."
                }
            }
        }
    }
}

Nested Schema : rule Object

Type: object

Title: rule Object

Show Source

• description(optional): string
  The Description of the rule.
• destination(optional): string
  The value DB_1.
• ports(optional): string
  The ports for the rule.
• ruleName(optional): string
  The name of the rule.
• ruleType(optional): string
  The type of the rule; one of: DEFAULT, SYSTEM or USER.
• source(optional): string
  IP addresses and subnets from which traffic is allowed.
• status(optional): string
  The status of the rule; one of: disabled or enabled.

{
    "title":"rule Object",
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The Description of the rule."
        },
        "destination":{
            "type":"string",
            "description":"The value <code>DB_1</code>."
        },
        "ports":{
            "type":"string",
            "description":"The ports for the rule."
        },
        "ruleName":{
            "type":"string",
            "description":"The name of the rule."
        },
        "ruleType":{
            "type":"string",
            "description":"The type of the rule; one of: <code>DEFAULT</code>, <code>SYSTEM</code> or <code>USER</code>."
        },
        "source":{
            "type":"string",
            "description":"IP addresses and subnets from which traffic is allowed."
        },
        "status":{
            "type":"string",
            "description":"The status of the rule; one of: <code>disabled</code> or <code>enabled</code>."
        }
    }
}

Back to Top

Examples

The following example shows how to disable a rule by submitting a PUT request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The service instance is db12c-xp-si and the Oracle Cloud user name of the user making the call is dbcsadmin. The rule being disabled is example-https.

Note that the request body is included directly in the cURL command by using the --data option.

cURL Command

$ curl --include --request PUT \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
--header "Content-Type: application/json" \
--data '{"operation":"update","status":"disabled"}' \
https://dbaas.oraclecloud.com/paas/api/v1.1/instancemgmt/usexample/services/dbaas/instances/db12c-xp-si/accessrules/example-https

HTTP Status Code and Response Headers

HTTP/1.1 200 OK
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Content-Length: 138
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Vary: Accept-Encoding,User-Agent
Content-Language: en
Content-Type: application/json

Response Body

{
  "ruleName":"example-https",
  "description":"",
  "status":"disabled",
  "source":"192.0.2.0/24",
  "destination":"DB_1",
  "ports":"443",
  "ruleType":"USER"
}

Back to Top