Oracle Waas API
The waas API from Oracle — 38 operation(s) for waas.
Oracle Waas API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Waas. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 66 operations across 38 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version 20181116.
Requests are made against a single base URL, /20181116.
66 operations
38 paths
65 schemas
5 DELETE32 GET10 POST19 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Oracle Waas API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (ApiKey).
By default, every request must be authenticated.
Paths & Operations 66
Across 38 paths, the API surfaces 66 operations — 5 DELETE, 32 GET, 10 POST, 19 PUT. Each is listed below with its method, path, parameters, and response codes.
waas 66
GET
/addressLists
Returns a list of address lists.
POST
/addressLists
Creates an address list.
DELETE
/addressLists/{addressListId}
Deletes an address list.
GET
/addressLists/{addressListId}
Returns the details of an address list.
PUT
/addressLists/{addressListId}
Updates the name and IP values of an address list.
POST
/addressLists/{addressListId}/actions/changeCompartment
Moves address list into a different compartment.
GET
/certificates
Returns a list of certificates.
POST
/certificates
Creates a certificate resource for the uploaded X.509 certificate.
DELETE
/certificates/{certificateId}
Deletes a certificate.
GET
/certificates/{certificateId}
Returns the details of a certificate.
PUT
/certificates/{certificateId}
Updates the display name, freeform tags, and defined tags of a certificate.
POST
/certificates/{certificateId}/actions/changeCompartment
Moves certificate into a different compartment.
GET
/customProtectionRules
Returns the list of Custom Protection rules for the given compartment.
POST
/customProtectionRules
Creates a new custom protection rule in the specified compartment.
DELETE
/customProtectionRules/{customProtectionRuleId}
Deletes a Custom Protection rule.
GET
/customProtectionRules/{customProtectionRuleId}
Returns the details of a Custom Protection rule.
PUT
/customProtectionRules/{customProtectionRuleId}
Updates the details of a custom protection rule.
POST
/customProtectionRules/{customProtectionRuleId}/actions/changeCompartment
Moves Custom Protection rule into a different compartment.
GET
/edgeSubnets
Returns a list of subnets corresponding the Web Application Firewall.
GET
/waasPolicies
Returns the list of policies for the given compartment.
POST
/waasPolicies
Creates a new policy in the specified compartment.
DELETE
/waasPolicies/{waasPolicyId}
Deletes a policy.
GET
/waasPolicies/{waasPolicyId}
Returns the details of a policy.
PUT
/waasPolicies/{waasPolicyId}
Updates the details of a policy.
POST
/waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations
Accepts a list of recommended Web Application Firewall protection rules.
POST
/waasPolicies/{waasPolicyId}/actions/changeCompartment
Moves WAAS policy into a different compartment.
POST
/waasPolicies/{waasPolicyId}/actions/purgeCache
Accepts a list of resources to be purged.
GET
/waasPolicies/{waasPolicyId}/policyConfig
Returns the general configuration for the policy.
PUT
/waasPolicies/{waasPolicyId}/policyConfig
Updates the policy configuration.
GET
/waasPolicies/{waasPolicyId}/reports/waf/blocked
Returns a list of requests blocked by the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/reports/waf/requests
Returns a list of requests handled by the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/reports/waf/traffic
Returns a list of traffic data for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig
Returns the Web Application Firewall configuration.
PUT
/waasPolicies/{waasPolicyId}/wafConfig
Updates the Web Application Firewall configuration.
GET
/waasPolicies/{waasPolicyId}/wafConfig/accessRules
Returns a list of access rules for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/accessRules
Updates the list of access rules for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/addressRateLimiting
Returns the rate limiting settings for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/addressRateLimiting
Updates the rate limiting settings for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/cachingRules
Returns the list of caching rules for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/cachingRules
Updates the list of caching rules for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/captchas
Returns a list of CAPTCHA configurations for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/captchas
Updates the list of CAPTCHA configurations for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/customProtectionRules
Returns the list of custom protection rules for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/customProtectionRules
Updates the list of custom protection rules for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/deviceFingerprintChallenge
Returns the device fingerprint challenge settings for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/deviceFingerprintChallenge
Updates the device fingerprint challenge settings for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/goodBots
Returns the list of good bot configurations for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/goodBots
Updates the list of good bot configurations for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/humanInteractionChallenge
Returns the human interaction challenge settings for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/humanInteractionChallenge
Updates the human interaction challenge settings for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/jsChallenge
Returns the JavaScript challenge settings for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/jsChallenge
Updates the JavaScript challenge settings for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/protectionRules
Returns the list of protection rules for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/protectionRules
Updates the list of protection rules for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/protectionRules/{protectionRuleKey}
Returns the details of a single protection rule.
GET
/waasPolicies/{waasPolicyId}/wafConfig/protectionSettings
Returns the protection settings for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/protectionSettings
Updates the protection settings for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafConfig/recommendations
Returns the list of recommended Web Application Firewall protection rules.
GET
/waasPolicies/{waasPolicyId}/wafConfig/threatFeeds
Returns a list of threat intelligence feeds.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/threatFeeds
Updates the action for each threat intelligence feed.
GET
/waasPolicies/{waasPolicyId}/wafConfig/whitelists
Returns a list of whitelists for the Web Application Firewall.
PUT
/waasPolicies/{waasPolicyId}/wafConfig/whitelists
Updates the list of whitelists for the Web Application Firewall.
GET
/waasPolicies/{waasPolicyId}/wafLogs
Returns a list of logs for the Web Application Firewall.
GET
/workRequests
Returns a list of work requests.
DELETE
/workRequests/{workRequestId}
Cancels a work request.
GET
/workRequests/{workRequestId}
Returns the details of a work request.
Schemas 65
The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are WafLog (28 properties), Certificate (19 properties), AccessRule (16 properties), WafConfig (15 properties). Each schema is shown below with its type and property counts.
Captcha
object
The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web ap…
7 properties
5 required
ChangeCertificateCompartmentDetails
object
1 property
1 required
Whitelist
object
An array of IP addresses that bypass the Web Application Firewall. Supports both single IP addresses or subnet masks (CIDR notation).
3 properties
1 required
WorkRequestSummary
object
The summarized details of a work request.
9 properties
7 required
Header
object
An HTTP header with name and value.
2 properties
2 required
HeaderManipulationAction
object
An object that represents an action to apply to an HTTP headers.
1 property
1 required
WafLog
object
A list of Web Application Firewall log entries. Each entry is a JSON object, including a timestamp property and other fields varying based on log type. Logs re…
28 properties
CustomProtectionRuleSummary
object
An overview of a custom protection rule.
8 properties
AccessRuleCriteria
object
When defined, the parent challenge would be applied only for the requests that matched all the listed conditions.
3 properties
2 required
LoadBalancingMethod
object
1 property
1 required
WafBlockedRequest
object
4 properties
ChangeAddressListCompartmentDetails
object
1 property
1 required
CertificateIssuerName
object
The issuer of the certificate.
7 properties
CreateAddressListDetails
object
The data used to create a new address list of IP addresses and CIDR notations.
5 properties
3 required
OriginGroup
object
1 property
AddressListSummary
object
A summary of the address list's information.
8 properties
ProtectionRuleAction
object
A protection rule key and the associated action to apply to that rule.
3 properties
2 required
Certificate
object
The details of the SSL certificate. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
19 properties
9 required
CertificateSubjectName
object
The entity to be secured by the certificate.
7 properties
WorkRequestError
object
An object returned in the event of a work request error.
3 properties
WafTrafficDatum
object
A time series of traffic data for the Web Application Firewall configured for a policy.
6 properties
WaasPolicyCustomProtectionRuleSummary
object
The OCID and action of a custom protection rule.
5 properties
ChangeCustomProtectionRuleCompartmentDetails
object
1 property
1 required
CustomProtectionRule
object
The details of a custom protection rule.
10 properties
ProtectionRuleExclusion
object
Allows specified types of requests to bypass the protection rule. If a request matches any of the criteria in the exclusions field, the protection rule will no…
2 properties
Origin
object
A detailed description of your web application's origin host server. An origin must be defined to set up WAF rules.
4 properties
1 required
UpdateCustomProtectionRuleDetails
object
Updates the configuration details of a custom protection rule. Custom protection rules can only be updated if they are not active in a WAAS policy. Warning: Or…
5 properties
WorkRequestLogEntry
object
A log message for a work request.
2 properties
CreateCustomProtectionRuleDetails
object
The required data to create a custom protection rule. For more information about custom protection rules, see [Custom Protection Rules](/iaas/Content/WAF/Tasks…
6 properties
3 required
BlockChallengeSettings
object
The challenge settings if action is set to BLOCK.
9 properties
CachingRule
WafConfig
object
The Web Application Firewall configuration for the WAAS policy.
15 properties
PurgeCache
object
The list of cached resources to purge. If a resource is not specified, the purge targets all rules in a policy.
1 property
CachingRuleCriteria
object
A caching rule criteria condition and value.
2 properties
2 required
UpdateWaasPolicyDetails
object
Updates the configuration details of a WAAS policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values…
8 properties
GoodBot
object
The good bot settings. Good bots provides a list of bots which are managed by known providers.
4 properties
2 required
JsChallenge
object
The JavaScript challenge settings. JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.
9 properties
1 required
DeviceFingerprintChallenge
object
The device fingerprint challenge settings. The device fingerprint challenge generates hashed signatures of both virtual and real browsers to identify and block…
8 properties
1 required
WorkRequest
object
Many of the API requests you use to create and configure WAAS policies do not take effect immediately. In these cases, the request spawns an asynchronous work…
11 properties
7 required
ChangeWaasPolicyCompartmentDetails
object
1 property
1 required
WafRequest
object
A time series of request counts handled by the Web Application Firewall, including blocked requests.
3 properties
ThreatFeed
object
The settings of the threat intelligence feed. You can block requests from IP addresses based on their reputations with various commercial and open source threa…
4 properties
AddressList
object
The details of the address list.
9 properties
CustomProtectionRuleSetting
object
The OCID and action of a custom protection rule.
3 properties
WaasPolicySummary
object
Summary information about a WAAS policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the A…
8 properties
ProtectionSettings
object
The settings used for protection rules.
13 properties
Recommendation
object
A recommended protection rule for a web application. This recommendation can be accepted to apply it to the Web Application Firewall configuration for this pol…
6 properties
ProtectionRule
object
The protection rule settings. Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.
7 properties
CachingRuleSummary
object
The caching rule settings.
7 properties
3 required
CreateWaasPolicyDetails
object
The required data to create a WAAS policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the…
10 properties
2 required
CreateCertificateDetails
object
The data used to create a new SSL certificate. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using…
7 properties
3 required
HumanInteractionChallenge
object
The human interaction challenge settings. The human interaction challenge checks various event listeners in the user's browser to determine if there is a human…
10 properties
1 required
WorkRequestResource
object
The resource on which the work request is operating.
4 properties
CertificateSummary
object
A summary of the SSL certificate's information. Warning: Oracle recommends that you avoid using any confidential information when you supply string values usin…
8 properties
ThreatFeedAction
object
The action to take for a request that has been determined to be potentially malicious.
2 properties
2 required
AccessRule
object
A content access rule. An access rule specifies an action to take if a set of criteria is matched by a request.
16 properties
3 required
EdgeSubnet
object
The details about an edge node subnet.
3 properties
AddressRateLimiting
object
The IP rate limiting configuration. Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold i…
4 properties
1 required
WaasPolicy
object
The details of a Web Application Acceleration and Security (WAAS) policy. A policy describes how the WAAS service should operate for the configured web applica…
14 properties
WafConfigDetails
object
The Web Application Firewall configuration for the WAAS policy creation.
12 properties
Error
object
An error code and message.
2 properties
2 required
UpdateCertificateDetails
object
The data used to create a new SSL certificate. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using…
3 properties
PolicyConfig
object
The configuration details for the WAAS policy.
14 properties
UpdateAddressListDetails
object
The data used to update the address list: IP addresses and CIDR notations.
4 properties
HealthCheck
object
Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is…
11 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#Waas
Where this information came from
This is an independent, third-party profile of Oracle Waas API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.