Jump to

• Request
• Response

View All Access Rules

get

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

Returns information about all access rules defined for an Oracle Integration Classic instance.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the Oracle Integration Classic account.
• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

The response body contains information about the access rules.

Root Schema : secrules-response

Type: object

The response body contains information about the access rules.

Show Source

• accessRules(optional): array accessRules
  Groups details about access rules.
• activities(optional): array activities
  Groups details about ongoing and failed activity messages, if available.

{
    "description":"The response body contains information about the access rules.",
    "properties":{
        "accessRules":{
            "type":"array",
            "description":"Groups details about access rules.",
            "items":{
                "$ref":"#/definitions/secrules-details"
            }
        },
        "activities":{
            "type":"array",
            "description":"Groups details about ongoing and failed activity messages, if available.",
            "items":{
                "$ref":"#/definitions/secrules-activities"
            }
        }
    }
}

Nested Schema : accessRules

Type: array

Groups details about access rules.

Show Source

• Array of: object secrules-details

{
    "type":"array",
    "description":"Groups details about access rules.",
    "items":{
        "$ref":"#/definitions/secrules-details"
    }
}

Nested Schema : activities

Type: array

Groups details about ongoing and failed activity messages, if available.

Show Source

• Array of: object secrules-activities

{
    "type":"array",
    "description":"Groups details about ongoing and failed activity messages, if available.",
    "items":{
        "$ref":"#/definitions/secrules-activities"
    }
}

Nested Schema : secrules-details

Type: object

Show Source

• description(optional): string
  Description of the rule.
• destination(optional): string
  The service component to allow traffic to. For example, WLS_ADMIN_SERVER or OTD.
• ports(optional): string
  Ports for the rule. This can be a single port or a port range.
• ruleName(optional): string
  Name of the rule.
• ruleType(optional): string
  Type of rule. For example, SYSTEM, DEFAULT, or USER.
• source(optional): string
  The hosts from which traffic is allowed. For example, PUBLIC-INTERNET for any host on the Internet, a single IP address or a comma-separated list of subnets (in CIDR format) or IPv4 addresses, or a service component name such as WLS_ADMIN_SERVER, WLS_MANAGED_SERVER, OTD, or DB.
• status(optional): string
  Status of the rule. Valid value: disabled or enabled.

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the rule."
        },
        "destination":{
            "type":"string",
            "description":"The service component to allow traffic to. For example, <code>WLS_ADMIN_SERVER</code> or <code>OTD</code>."
        },
        "ruleName":{
            "type":"string",
            "description":"Name of the rule."
        },
        "ruleType":{
            "type":"string",
            "description":"Type of rule. For example, <code>SYSTEM</code>, <code>DEFAULT</code>, or <code>USER</code>."
        },
        "ports":{
            "type":"string",
            "description":"Ports for the rule. This can be a single port or a port range."
        },
        "source":{
            "type":"string",
            "description":"The hosts from which traffic is allowed. For example, <code>PUBLIC-INTERNET</code> for any host on the Internet, a single IP address or a comma-separated list of subnets (in CIDR format) or IPv4 addresses, or a service component name such as <code>WLS_ADMIN_SERVER</code>, <code>WLS_MANAGED_SERVER</code>, <code>OTD</code>, or <code>DB</code>."
        },
        "status":{
            "type":"string",
            "description":"Status of the rule. Valid value: <code>disabled</code> or <code>enabled</code>."
        }
    }
}

Nested Schema : secrules-activities

Type: object

Show Source

• activity(optional): array activity
  Groups messages and errors for ongoing and failed activities.

{
    "properties":{
        "activity":{
            "type":"array",
            "description":"Groups messages and errors for ongoing and failed activities.",
            "items":{
                "$ref":"#/definitions/message-errors"
            }
        }
    }
}

Nested Schema : activity

Type: array

Groups messages and errors for ongoing and failed activities.

Show Source

• Array of: object message-errors

{
    "type":"array",
    "description":"Groups messages and errors for ongoing and failed activities.",
    "items":{
        "$ref":"#/definitions/message-errors"
    }
}

Nested Schema : message-errors

Type: object

Show Source

• errors(optional): string
  Error encountered for an ongoing or failed activity.
• message(optional): string
  Message of an ongoing or failed activity.

{
    "properties":{
        "errors":{
            "type":"string",
            "description":"Error encountered for an ongoing or failed activity."
        },
        "message":{
            "type":"string",
            "description":"Message of an ongoing or failed activity."
        }
    }
}

Back to Top