{ "opencollection": "1.0.0", "info": { "name": "Web Application Acceleration and Security Services Waas API", "version": "20181116" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "waas", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of address lists.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/addressLists", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The value by which address lists are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created." }, { "name": "id", "value": "", "type": "query", "description": "Filter address lists using a list of address lists OCIDs." }, { "name": "name", "value": "", "type": "query", "description": "Filter address lists using a list of names." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter address lists using a list of lifecycle states." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that matches address lists created on or after the specified date-time." }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "A filter that matches address lists created before the specified date-time." } ] }, "docs": "Gets a list of address lists that can be used in a WAAS policy." }, { "info": { "name": "Creates an address list.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/addressLists", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an address list in a set compartment and allows it to be used in a WAAS policy and referenced by access rules. Addresses can be IP addresses and CIDR notations." }, { "info": { "name": "Returns the details of an address list.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/addressLists/:addressListId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "addressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment." } ] }, "docs": "Gets the details of an address list." }, { "info": { "name": "Updates the name and IP values of an address list.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/addressLists/:addressListId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "addressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of an address list. Only the fields specified in the request body will be updated; all other properties will remain unchanged." }, { "info": { "name": "Deletes an address list.", "type": "http" }, "http": { "method": "DELETE", "url": "/20181116/addressLists/:addressListId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "addressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment." } ] }, "docs": "Deletes the address list from the compartment if it is not used." }, { "info": { "name": "Moves address list into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/addressLists/:addressListId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "addressListId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the address list. This number is generated when the address list is added to the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves address list into a different compartment. When provided, If-Match\nis checked against ETag values of the address list. For information about moving\nresources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Returns a list of certificates.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/certificates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The value by which certificate summaries are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created." }, { "name": "id", "value": "", "type": "query", "description": "Filter certificates using a list of certificates OCIDs." }, { "name": "displayName", "value": "", "type": "query", "description": "Filter certificates using a list of display names." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter certificates using a list of lifecycle states." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that matches certificates created on or after the specified date-time." }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "A filter that matches certificates created before the specified date-time." } ] }, "docs": "Gets a list of SSL certificates that can be used in a WAAS policy." }, { "info": { "name": "Creates a certificate resource for the uploaded X.509 certificate.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/certificates", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows an SSL certificate to be added to a WAAS policy. The Web Application Firewall terminates SSL connections to inspect requests in runtime, and then re-encrypts requests before sending them to the origin for fulfillment.\n\nFor more information, see [WAF Settings](/iaas/Content/WAF/Tasks/wafsettings.htm)." }, { "info": { "name": "Returns the details of a certificate.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/certificates/:certificateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy." } ] }, "docs": "Gets the details of an SSL certificate." }, { "info": { "name": "Updates the display name, freeform tags, and defined tags of a certificate.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/certificates/:certificateId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "It is not possible to update a certificate, only create and delete. Therefore, this operation can only update the display name, freeform tags, and defined tags of a certificate." }, { "info": { "name": "Deletes a certificate.", "type": "http" }, "http": { "method": "DELETE", "url": "/20181116/certificates/:certificateId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy." } ] }, "docs": "Deletes an SSL certificate from the WAAS service." }, { "info": { "name": "Moves certificate into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/certificates/:certificateId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the SSL certificate used in the WAAS policy. This number is generated when the certificate is added to the policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves certificate into a different compartment. When provided, If-Match is checked against ETag values of the certificate.\nFor information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Returns the list of Custom Protection rules for the given compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/customProtectionRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The value by which custom protection rules are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`." }, { "name": "id", "value": "", "type": "query", "description": "Filter custom protection rules using a list of custom protection rule OCIDs." }, { "name": "displayName", "value": "", "type": "query", "description": "Filter custom protection rules using a list of display names." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter Custom Protection rules using a list of lifecycle states." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that matches Custom Protection rules created on or after the specified date-time." }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "A filter that matches custom protection rules created before the specified date-time." } ] }, "docs": "Gets a list of custom protection rules for the specified Web Application Firewall." }, { "info": { "name": "Creates a new custom protection rule in the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/customProtectionRules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new custom protection rule in the specified compartment.\n\nCustom protection rules allow you to create rules in addition to the rulesets provided by the Web Application Firewall service, including rules from [ModSecurity](https://modsecurity.org/). The syntax for custom rules is based on the ModSecurity syntax. For more information about custom protection rules, see [Custom Protection Rules](/iaas/Content/WAF/Tasks/customprotectionrules.htm)." }, { "info": { "name": "Returns the details of a Custom Protection rule.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/customProtectionRules/:customProtectionRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "customProtectionRuleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment." } ] }, "docs": "Gets the details of a custom protection rule." }, { "info": { "name": "Updates the details of a custom protection rule.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/customProtectionRules/:customProtectionRuleId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "customProtectionRuleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a custom protection rule. Only the fields specified in the request body will be updated; all other properties will remain unchanged." }, { "info": { "name": "Deletes a Custom Protection rule.", "type": "http" }, "http": { "method": "DELETE", "url": "/20181116/customProtectionRules/:customProtectionRuleId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "customProtectionRuleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment." } ] }, "docs": "Deletes a Custom Protection rule." }, { "info": { "name": "Moves Custom Protection rule into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/customProtectionRules/:customProtectionRuleId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "customProtectionRuleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the custom protection rule. This number is generated when the custom protection rule is added to the compartment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a custom protection rule into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the custom protection rule. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)." }, { "info": { "name": "Returns a list of subnets corresponding the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/edgeSubnets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The value by which edge node subnets are sorted in a paginated 'List' call. If unspecified, defaults to `timeModified`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`." } ] }, "docs": "Return the list of the tenant's edge node subnets. Use these CIDR blocks to restrict incoming traffic to your origin. These subnets are owned by OCI and forward traffic to customer origins. They are not associated with specific regions or compartments." }, { "info": { "name": "Returns the list of policies for the given compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The value by which policies are sorted in a paginated 'List' call. If unspecified, defaults to `timeCreated`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`." }, { "name": "id", "value": "", "type": "query", "description": "Filter policies using a list of policy OCIDs." }, { "name": "displayName", "value": "", "type": "query", "description": "Filter policies using a list of display names." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter policies using a list of lifecycle states." }, { "name": "timeCreatedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that matches policies created on or after the specified date and time." }, { "name": "timeCreatedLessThan", "value": "", "type": "query", "description": "A filter that matches policies created before the specified date-time." } ] }, "docs": "Gets a list of WAAS policies." }, { "info": { "name": "Creates a new policy in the specified compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/waasPolicies", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Web Application Acceleration and Security (WAAS) policy in the specified compartment. A WAAS policy must be established before creating Web Application Firewall (WAF) rules. To use WAF rules, your web application's origin servers must defined in the `WaasPolicy` schema.\n\nA domain name must be specified when creating a WAAS policy. The domain name should be different from the origins specified in your `WaasPolicy`. Once domain name is entered and stored, it is unchangeable.\n\nUse the" }, { "info": { "name": "Returns the details of a policy.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the details of a WAAS policy." }, { "info": { "name": "Updates the details of a policy.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of a WAAS policy, including origins and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.\nTo update platform provided resources such as `GoodBots`, `ProtectionRules`, and `ThreatFeeds`, first retrieve the list of available resources with the related list operation such as `GetThreatFeeds` or `GetProtectionRules`.\nThe returned list will contain objects with `key` properties that can be used to update the resource d" }, { "info": { "name": "Deletes a policy.", "type": "http" }, "http": { "method": "DELETE", "url": "/20181116/waasPolicies/:waasPolicyId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Deletes a policy." }, { "info": { "name": "Accepts a list of recommended Web Application Firewall protection rules.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/waasPolicies/:waasPolicyId/actions/acceptWafConfigRecommendations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accepts a list of recommended Web Application Firewall protection rules. Web Application Firewall protection rule recommendations are sets of rules generated by observed traffic patterns through the Web Application Firewall and are meant to optimize the Web Application Firewall's security profile. Only the rules specified in the request body will be updated; all other rules will remain unchanged.\n\nUse the `GET /waasPolicies/{waasPolicyId}/wafConfig/recommendations` method to view a list of recom" }, { "info": { "name": "Moves WAAS policy into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/waasPolicies/:waasPolicyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves WAAS policy into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.\nFor information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Accepts a list of resources to be purged.", "type": "http" }, "http": { "method": "POST", "url": "/20181116/waasPolicies/:waasPolicyId/actions/purgeCache", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a purge of the cache for each specified resource. If no resources are passed, the cache for the entire Web Application Firewall will be purged.\nFor more information, see [Caching Rules](/iaas/Content/WAF/Tasks/cachingrules.htm#purge)." }, { "info": { "name": "Returns the general configuration for the policy.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/policyConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the configuration of a WAAS policy." }, { "info": { "name": "Updates the policy configuration.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/policyConfig", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration for a WAAS policy. Only the fields specified in the request body will be updated; all other properties will remain unchanged." }, { "info": { "name": "Returns a list of requests blocked by the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/reports/waf/blocked", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "timeObservedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that limits returned events to those occurring on or after a date and time, specified in RFC 3339 format. If unspecified, defaults to 30 minutes before receipt of the request." }, { "name": "timeObservedLessThan", "value": "", "type": "query", "description": "A filter that limits returned events to those occurring before a date and time, specified in RFC 3339 format." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "wafFeature", "value": "", "type": "query", "description": "Filter stats by the Web Application Firewall feature that triggered the block action. If unspecified, data for all WAF features will be returned." } ] }, "docs": "Gets the number of blocked requests by a Web Application Firewall feature in five minute blocks, sorted by `timeObserved` in ascending order (starting from oldest data)." }, { "info": { "name": "Returns a list of requests handled by the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/reports/waf/requests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "timeObservedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that limits returned events to those occurring on or after a date and time, specified in RFC 3339 format. If unspecified, defaults to 30 minutes before receipt of the request." }, { "name": "timeObservedLessThan", "value": "", "type": "query", "description": "A filter that limits returned events to those occurring before a date and time, specified in RFC 3339 format." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the number of requests managed by a Web Application Firewall\nover a specified period of time, including blocked requests. Sorted\nby `timeObserved` in ascending order (starting from oldest requests).\n" }, { "info": { "name": "Returns a list of traffic data for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/reports/waf/traffic", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "timeObservedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that limits returned events to those occurring on or after a date and time, specified in RFC 3339 format. If unspecified, defaults to 30 minutes before receipt of the request." }, { "name": "timeObservedLessThan", "value": "", "type": "query", "description": "A filter that limits returned events to those occurring before a date and time, specified in RFC 3339 format." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the Web Application Firewall traffic data for a WAAS policy.\nSorted by `timeObserved` in ascending order (starting from oldest data).\n" }, { "info": { "name": "Returns the Web Application Firewall configuration.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the Web Application Firewall configuration details for a WAAS policy." }, { "info": { "name": "Updates the Web Application Firewall configuration.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Web Application Firewall configuration for a specified WAAS policy.\n\nTo update platform provided resources such as `GoodBots`, `ProtectionRules`, and `ThreatFeeds`,\nfirst retrieve the list of available resources with the related list operation, such as\n`GetThreatFeeds` or `GetProtectionRules`.\n\nThe returned list will contain objects with `key` properties that can be used to update the\nresource during the `UpdateWafConfig` request.\n" }, { "info": { "name": "Returns a list of access rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/accessRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the currently configured access rules for the Web Application Firewall configuration of a specified WAAS policy.\nThe order of the access rules is important. The rules will be checked in the order they are specified and the first matching rule will be used." }, { "info": { "name": "Updates the list of access rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/accessRules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of access rules in the Web Application Firewall configuration for a specified WAAS policy. Access rules allow explicit actions to be defined and executed for requests that meet various conditions. A rule action can be set to allow, detect, or block requests. The detect setting allows the request to pass through the Web Application Firewall and is tagged with a `DETECT` flag in the Web Application Firewall's log.\n\nThis operation can create, delete, update, and/or reorder access r" }, { "info": { "name": "Returns the rate limiting settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/addressRateLimiting", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the address rate limiting settings of the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Updates the rate limiting settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/addressRateLimiting", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the address rate limiting settings in the Web Application Firewall configuration for a policy. Rate limiting allows you to configure a threshold for the number of requests from a unique IP address for the given period. You can also define the response code for the requests from the same address that exceed the threshold." }, { "info": { "name": "Returns the list of caching rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/cachingRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the currently configured caching rules for the Web Application Firewall configuration of a specified WAAS policy.\nThe rules are processed in the order they are specified in and the first matching rule will be used when processing a request." }, { "info": { "name": "Updates the list of caching rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/cachingRules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration for each specified caching rule.\n\nCaching rules WAF policies allow you to selectively cache content on Oracle Cloud Infrastructure's edge servers, such as webpages or certain file types. For more information about caching rules, see [Caching Rules](/iaas/Content/WAF/Tasks/cachingrules.htm).\n\nThis operation can create, delete, update, and/or reorder caching rules depending on the structure of the request body. Caching rules can be updated by changing the properties of th" }, { "info": { "name": "Returns a list of CAPTCHA configurations for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/captchas", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the list of currently configured CAPTCHA challenges in the Web\nApplication Firewall configuration of a WAAS policy.\n\nThe order of the CAPTCHA challenges is important. The URL for each\nCAPTCHA will be checked in the order they are created.\n" }, { "info": { "name": "Updates the list of CAPTCHA configurations for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/captchas", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of CAPTCHA challenges in the Web Application Firewall configuration for a WAAS policy.\nThis operation can create, update, or delete CAPTCHAs depending on the structure of the request body.\nCAPTCHA challenges can be updated by changing the properties of the CAPTCHA object with the rule's key specified in the key field. CAPTCHA challenges can be reordered by changing the order of the CAPTCHA challenges in the list when updating.\n\nCAPTCHA challenges can be created by adding a new a" }, { "info": { "name": "Returns the list of custom protection rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/customProtectionRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "modSecurityRuleId", "value": "", "type": "query", "description": "Filter rules using a list of ModSecurity rule IDs." }, { "name": "action", "value": "", "type": "query", "description": "Filter rules using a list of actions." } ] }, "docs": "Gets the list of currently configured custom protection rules for a WAAS policy." }, { "info": { "name": "Updates the list of custom protection rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/customProtectionRules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the action for each specified custom protection rule. Only the `DETECT` and `BLOCK` actions can be set. Disabled rules should not be included in the list. For more information on protection rules, see [WAF Protection Rules](/iaas/Content/WAF/Tasks/wafprotectionrules.htm)." }, { "info": { "name": "Returns the device fingerprint challenge settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/deviceFingerprintChallenge", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the device fingerprint challenge settings in the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Updates the device fingerprint challenge settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/deviceFingerprintChallenge", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Device Fingerprint Challenge (DFC) settings in the Web Application Firewall configuration for a policy. The DFC generates a hashed signature of both virtual and real browsers based on 50+ attributes. These proprietary signatures are then leveraged for real-time correlation to identify and block malicious bots.\n\nThe signature is based on a library of attributes detected via JavaScript listeners; the attributes include OS, screen resolution, fonts, UserAgent, IP address, etc. We are co" }, { "info": { "name": "Returns the list of good bot configurations for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/goodBots", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the list of good bots defined in the Web Application Firewall configuration for a WAAS policy.\n\nThe list is sorted by `key`, in ascending order.\n" }, { "info": { "name": "Updates the list of good bot configurations for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/goodBots", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of good bots in the Web Application Firewall configuration for a policy. Only the fields specified in the request body will be updated, all other configuration properties will remain unchanged.\n\nGood bots allows you to manage access for bots from known providers, such as Google or Baidu. For more information about good bots, see [Bot Management](/iaas/Content/WAF/Tasks/botmanagement.htm)." }, { "info": { "name": "Returns the human interaction challenge settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/humanInteractionChallenge", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the human interaction challenge settings in the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Updates the human interaction challenge settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/humanInteractionChallenge", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Human Interaction Challenge (HIC) settings in the Web Application Firewall configuration for a WAAS policy. HIC is a countermeasure that allows the proxy to check the user's browser for various behaviors that distinguish a human presence from a bot." }, { "info": { "name": "Returns the JavaScript challenge settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/jsChallenge", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Updates the JavaScript challenge settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/jsChallenge", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the JavaScript challenge settings in the Web Application Firewall configuration for a WAAS policy. JavaScript Challenge validates that the client can accept JavaScript with a binary decision. For more information, see [Bot Management](/iaas/Content/WAF/Tasks/botmanagement.htm)." }, { "info": { "name": "Returns the list of protection rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/protectionRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "modSecurityRuleId", "value": "", "type": "query", "description": "Filter rules using a list of ModSecurity rule IDs." }, { "name": "action", "value": "", "type": "query", "description": "Filter rules using a list of actions." } ] }, "docs": "Gets the list of available protection rules for a WAAS policy. Use the `GetWafConfig` operation to view a list of currently configured protection rules for the Web Application Firewall, or use the `ListRecommendations` operation to get a list of recommended protection rules for the Web Application Firewall.\nThe list is sorted by `key`, in ascending order." }, { "info": { "name": "Updates the list of protection rules for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/protectionRules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the action for each specified protection rule. Requests can either be allowed, blocked, or trigger an alert if they meet the parameters of an applied rule. For more information on protection rules, see [WAF Protection Rules](/iaas/Content/WAF/Tasks/wafprotectionrules.htm).\nThis operation can update or disable protection rules depending on the structure of the request body.\nProtection rules can be updated by changing the properties of the protection rule object with the rule's key specifi" }, { "info": { "name": "Returns the details of a single protection rule.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/protectionRules/:protectionRuleKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "protectionRuleKey", "value": "", "type": "path", "description": "The protection rule key." } ] }, "docs": "Gets the details of a protection rule in the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Returns the protection settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/protectionSettings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ] }, "docs": "Gets the protection settings in the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Updates the protection settings for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/protectionSettings", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the protection settings in the Web Application Firewall configuration for a WAAS policy. Protection settings allow you define what action is taken when a request is blocked by the Web Application Firewall, such as returning a response code or block page. Only the fields specified in the request body will be updated; all other fields will remain unchanged." }, { "info": { "name": "Returns the list of recommended Web Application Firewall protection rules.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/recommendations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "recommendedAction", "value": "", "type": "query", "description": "A filter that matches recommended protection rules based on the selected action. If unspecified, rules with any action type are returned." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the list of recommended Web Application Firewall protection rules.\n\nUse the `POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations` method to accept recommended Web Application Firewall protection rules. For more information, see [WAF Protection Rules](/iaas/Content/WAF/Tasks/wafprotectionrules.htm).\nThe list is sorted by `key`, in ascending order." }, { "info": { "name": "Returns a list of threat intelligence feeds.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/threatFeeds", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the list of available web application threat intelligence feeds\nand the actions set for each feed. The list is sorted by `key`,\nin ascending order.\n" }, { "info": { "name": "Updates the action for each threat intelligence feed.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/threatFeeds", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the action to take when a request's IP address matches an address in the specified threat intelligence feed. Threat intelligence feeds are compiled lists of IP addresses with malicious reputations based on internet intelligence. Only the threat feeds specified in the request body will be updated; all other threat feeds will remain unchanged." }, { "info": { "name": "Returns a list of whitelists for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/whitelists", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." } ] }, "docs": "Gets the list of whitelists defined in the Web Application Firewall configuration for a WAAS policy." }, { "info": { "name": "Updates the list of whitelists for the Web Application Firewall.", "type": "http" }, "http": { "method": "PUT", "url": "/20181116/waasPolicies/:waasPolicyId/wafConfig/whitelists", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of IP addresses that bypass the Web Application Firewall for a WAAS policy. Supports single IP addresses, subnet masks (CIDR notation) and Address Lists.\n\nThis operation can create, delete, update, and/or reorder whitelists depending on the structure of the request body.\n\nWhitelists can be updated by changing the properties of the whitelist object with the rule's key specified in the `key` field. Whitelists can be reordered by changing the order of the whitelists in the list of " }, { "info": { "name": "Returns a list of logs for the Web Application Firewall.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/waasPolicies/:waasPolicyId/wafLogs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the WAAS policy." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `20`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "timeObservedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter that matches log entries where the observed event occurred on or after a date and time specified in RFC 3339 format. If unspecified, defaults to two hours before receipt of the request." }, { "name": "timeObservedLessThan", "value": "", "type": "query", "description": "A filter that matches log entries where the observed event occurred before a date and time, specified in RFC 3339 format." }, { "name": "textContains", "value": "", "type": "query", "description": "A full text search for logs." }, { "name": "accessRuleKey", "value": "", "type": "query", "description": "Filters logs by access rule key." }, { "name": "action", "value": "", "type": "query", "description": "Filters logs by Web Application Firewall action." }, { "name": "clientAddress", "value": "", "type": "query", "description": "Filters logs by client IP address." }, { "name": "countryCode", "value": "", "type": "query", "description": "Filters logs by country code. Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/)." }, { "name": "countryName", "value": "", "type": "query", "description": "Filter logs by country name." }, { "name": "fingerprint", "value": "", "type": "query", "description": "Filter logs by device fingerprint." }, { "name": "httpMethod", "value": "", "type": "query", "description": "Filter logs by HTTP method." }, { "name": "incidentKey", "value": "", "type": "query", "description": "Filter logs by incident key." }, { "name": "logType", "value": "", "type": "query", "description": "Filter by log type. For more information about WAF logs, see [Logs](/iaas/Content/WAF/Tasks/logs.htm)." }, { "name": "originAddress", "value": "", "type": "query", "description": "Filter by origin IP address." }, { "name": "referrer", "value": "", "type": "query", "description": "Filter by referrer." }, { "name": "requestUrl", "value": "", "type": "query", "description": "Filter by request URL." }, { "name": "responseCode", "value": "", "type": "query", "description": "Filter by response code." }, { "name": "threatFeedKey", "value": "", "type": "query", "description": "Filter by threat feed key." }, { "name": "userAgent", "value": "", "type": "query", "description": "Filter by user agent." }, { "name": "protectionRuleKey", "value": "", "type": "query", "description": "Filter by protection rule key." } ] }, "docs": "Gets structured Web Application Firewall event logs for a WAAS\npolicy. Sorted by the `timeObserved` in ascending order (starting from the\noldest recorded event).\n" }, { "info": { "name": "Returns a list of work requests.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "waasPolicyId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the policy." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. This number is generated when the compartment is created." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated call. If unspecified, defaults to `10`." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous paginated call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The value by which work requests are sorted in a paginated 'List' call. If unspecified, defaults to `timeAccepted`." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to `DESC`." } ] }, "docs": "Gets a list of subnets (CIDR notation) from which the WAAS EDGE may make requests. The subnets are owned by OCI and forward traffic to your origins. Allow traffic from these subnets to your origins. They are not associated with specific regions or compartments." }, { "info": { "name": "Returns the details of a work request.", "type": "http" }, "http": { "method": "GET", "url": "/20181116/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. This number is generated when work request is created." } ] }, "docs": "Gets the details of a specified work request." }, { "info": { "name": "Cancels a work request.", "type": "http" }, "http": { "method": "DELETE", "url": "/20181116/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. This number is generated when work request is created." } ] }, "docs": "Cancels a specified work request." } ] } ], "bundled": true }