AWS WAFV2
WAF This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
WAF
This is the latest version of the WAF API,
released in November, 2019. The names of the entities that you use to access this API,
like endpoints and namespaces, all have the versioning information added, like "V2" or
"v2", to distinguish from the prior version. We recommend migrating your resources to
this version, because it has a number of significant improvements.
If you used WAF prior to this release, you can't use this WAFV2 API to access any
WAF resources that you created before. WAF Classic support will end on September 30, 2025.
For information about WAF, including how to migrate your WAF Classic resources to this version,
see the WAF Developer Guide .
WAF is a web application firewall that lets you monitor the HTTP and HTTPS
requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
GraphQL API, Amazon Cognito user pool, App Runner service, Amplify application, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content,
to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
you specify, such as the IP addresses that requests originate from or the values of query
strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
(Forbidden), or with a custom response.
This API guide is for developers who need detailed information about WAF API actions,
data types, and errors. For detailed information about WAF features and guidance for configuring and using
WAF, see the WAF Developer
Guide .
You can make calls using the endpoints listed in WAF endpoints and quotas .
For regional resources, you can use any of the endpoints in the list.
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
For Amazon CloudFront and Amplify, you must use the API endpoint listed for
US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the
programming language or platform that you're using. For more information, see Amazon Web Services SDKs .
Endpoints 59
- POSTAssociate web aCL
/#X-Amz-Target=AWSWAF_20190729.AssociateWebACLAssociates a web ACL with a resource, to protect the resource. Use this for all resource types except for Amazon CloudFront distributions. For Amazon… - POSTCheck capacity
/#X-Amz-Target=AWSWAF_20190729.CheckCapacityReturns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules… - POSTCreate aPI key
/#X-Amz-Target=AWSWAF_20190729.CreateAPIKeyCreates an API key that contains a set of token domains. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications.… - POSTCreate iP set
/#X-Amz-Target=AWSWAF_20190729.CreateIPSetCreates an IPSet , which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're… - POSTCreate regex pattern set
/#X-Amz-Target=AWSWAF_20190729.CreateRegexPatternSetCreates a RegexPatternSet , which you reference in a RegexPatternSetReferenceStatement , to have WAF inspect a web request component for the specified patterns. - POSTCreate rule group
/#X-Amz-Target=AWSWAF_20190729.CreateRuleGroupCreates a RuleGroup per the specifications provided. A rule group defines a collection of rules to inspect and control web requests that you can use in a… - POSTCreate web aCL
/#X-Amz-Target=AWSWAF_20190729.CreateWebACLCreates a WebACL per the specifications provided. A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a… - POSTDelete aPI key
/#X-Amz-Target=AWSWAF_20190729.DeleteAPIKeyDeletes the specified API key. After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions. - POSTDelete firewall manager rule groups
/#X-Amz-Target=AWSWAF_20190729.DeleteFirewallManagerRuleGroupsDeletes all rule groups that are managed by Firewall Manager from the specified WebACL . You can only use this if ManagedByFirewallManager and… - POSTDelete iP set
/#X-Amz-Target=AWSWAF_20190729.DeleteIPSetDeletes the specified IPSet . - POSTDelete logging configuration
/#X-Amz-Target=AWSWAF_20190729.DeleteLoggingConfigurationDeletes the LoggingConfiguration from the specified web ACL. - POSTDelete permission policy
/#X-Amz-Target=AWSWAF_20190729.DeletePermissionPolicyPermanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. - POSTDelete regex pattern set
/#X-Amz-Target=AWSWAF_20190729.DeleteRegexPatternSetDeletes the specified RegexPatternSet . - POSTDelete rule group
/#X-Amz-Target=AWSWAF_20190729.DeleteRuleGroupDeletes the specified RuleGroup . - POSTDelete web aCL
/#X-Amz-Target=AWSWAF_20190729.DeleteWebACLDeletes the specified WebACL . You can only use this if ManagedByFirewallManager is false in the web ACL. Before deleting any web ACL, first disassociate it… - POSTDescribe all managed products
/#X-Amz-Target=AWSWAF_20190729.DescribeAllManagedProductsProvides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. - POSTDescribe managed products by vendor
/#X-Amz-Target=AWSWAF_20190729.DescribeManagedProductsByVendorProvides high-level information for the managed rule groups owned by a specific vendor. - POSTDescribe managed rule group
/#X-Amz-Target=AWSWAF_20190729.DescribeManagedRuleGroupProvides high-level information for a managed rule group, including descriptions of the rules. - POSTDisassociate web aCL
/#X-Amz-Target=AWSWAF_20190729.DisassociateWebACLDisassociates the specified resource from its web ACL association, if it has one. Use this for all resource types except for Amazon CloudFront distributions.… - POSTGenerate mobile sdk release url
/#X-Amz-Target=AWSWAF_20190729.GenerateMobileSdkReleaseUrlGenerates a presigned download URL for the specified release of the mobile SDK. The mobile SDK is not generally available. Customers who have access to the… - POSTGet decrypted aPI key
/#X-Amz-Target=AWSWAF_20190729.GetDecryptedAPIKeyReturns your API key in decrypted form. Use this to check the token domains that you have defined for the key. API keys are required for the integration of… - POSTGet iP set
/#X-Amz-Target=AWSWAF_20190729.GetIPSetRetrieves the specified IPSet . - POSTGet logging configuration
/#X-Amz-Target=AWSWAF_20190729.GetLoggingConfigurationReturns the LoggingConfiguration for the specified web ACL. - POSTGet managed rule set
/#X-Amz-Target=AWSWAF_20190729.GetManagedRuleSetRetrieves the specified managed rule set. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web… - POSTGet mobile sdk release
/#X-Amz-Target=AWSWAF_20190729.GetMobileSdkReleaseRetrieves information for the specified mobile SDK release, including release notes and tags. The mobile SDK is not generally available. Customers who have… - POSTGet permission policy
/#X-Amz-Target=AWSWAF_20190729.GetPermissionPolicyReturns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation. - POSTGet rate based statement managed keys
/#X-Amz-Target=AWSWAF_20190729.GetRateBasedStatementManagedKeysRetrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the… - POSTGet regex pattern set
/#X-Amz-Target=AWSWAF_20190729.GetRegexPatternSetRetrieves the specified RegexPatternSet . - POSTGet revenue statistics
/#X-Amz-Target=AWSWAF_20190729.GetRevenueStatisticsRetrieves ranked monetization statistics. Use the StatisticType parameter to specify the ranking: TOP_SOURCES_BY_REVENUE for top sources by revenue, or… - POSTGet revenue statistics summary
/#X-Amz-Target=AWSWAF_20190729.GetRevenueStatisticsSummaryRetrieves a summary of monetization revenue for the specified time window. Returns total revenue, revenue by verification tier, total settlements, and total… - POSTGet revenue statistics time series
/#X-Amz-Target=AWSWAF_20190729.GetRevenueStatisticsTimeSeriesRetrieves time series data for monetization revenue. Returns data points aggregated at the specified interval for the given time window. This operation is… - POSTGet rule group
/#X-Amz-Target=AWSWAF_20190729.GetRuleGroupRetrieves the specified RuleGroup . - POSTGet sampled requests
/#X-Amz-Target=AWSWAF_20190729.GetSampledRequestsGets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web… - POSTGet top path statistics by traffic
/#X-Amz-Target=AWSWAF_20190729.GetTopPathStatisticsByTrafficRetrieves aggregated statistics about the top URI paths accessed by bot traffic for a specified web ACL and time window. You can use this operation to analyze… - POSTGet web aCL
/#X-Amz-Target=AWSWAF_20190729.GetWebACLRetrieves the specified WebACL . - POSTGet web aCL for resource
/#X-Amz-Target=AWSWAF_20190729.GetWebACLForResourceRetrieves the WebACL for the specified resource. This call uses GetWebACL , to verify that your account has permission to access the retrieved web ACL. If you… - POSTList aPI keys
/#X-Amz-Target=AWSWAF_20190729.ListAPIKeysRetrieves a list of the API keys that you've defined for the specified scope. API keys are required for the integration of the CAPTCHA API in your JavaScript… - POSTList available managed rule group versions
/#X-Amz-Target=AWSWAF_20190729.ListAvailableManagedRuleGroupVersionsReturns a list of the available versions for the specified managed rule group. - POSTList available managed rule groups
/#X-Amz-Target=AWSWAF_20190729.ListAvailableManagedRuleGroupsRetrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of… - POSTList iP sets
/#X-Amz-Target=AWSWAF_20190729.ListIPSetsRetrieves an array of IPSetSummary objects for the IP sets that you manage. - POSTList logging configurations
/#X-Amz-Target=AWSWAF_20190729.ListLoggingConfigurationsRetrieves an array of your LoggingConfiguration objects. - POSTList managed rule sets
/#X-Amz-Target=AWSWAF_20190729.ListManagedRuleSetsRetrieves the managed rule sets that you own. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web… - POSTList mobile sdk releases
/#X-Amz-Target=AWSWAF_20190729.ListMobileSdkReleasesRetrieves a list of the available releases for the mobile SDK and the specified device platform. The mobile SDK is not generally available. Customers who have… - POSTList regex pattern sets
/#X-Amz-Target=AWSWAF_20190729.ListRegexPatternSetsRetrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage. - POSTList resources for web aCL
/#X-Amz-Target=AWSWAF_20190729.ListResourcesForWebACLRetrieves an array of the Amazon Resource Names (ARNs) for the resources that are associated with the specified web ACL. For Amazon CloudFront, don't use this… - POSTList rule groups
/#X-Amz-Target=AWSWAF_20190729.ListRuleGroupsRetrieves an array of RuleGroupSummary objects for the rule groups that you manage. - POSTList settlement records
/#X-Amz-Target=AWSWAF_20190729.ListSettlementRecordsRetrieves individual settlement transaction records for monetization. Each record represents a single payment transaction between a client and your protected… - POSTList tags for resource
/#X-Amz-Target=AWSWAF_20190729.ListTagsForResourceRetrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes… - POSTList web aC ls
/#X-Amz-Target=AWSWAF_20190729.ListWebACLsRetrieves an array of WebACLSummary objects for the web ACLs that you manage. - POSTPut logging configuration
/#X-Amz-Target=AWSWAF_20190729.PutLoggingConfigurationEnables the specified LoggingConfiguration , to start logging from a web ACL, according to the configuration provided. If you configure data protection for… - POSTPut managed rule set versions
/#X-Amz-Target=AWSWAF_20190729.PutManagedRuleSetVersionsDefines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.… - POSTPut permission policy
/#X-Amz-Target=AWSWAF_20190729.PutPermissionPolicyUse this to share a rule group with other accounts. This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to… - POSTTag resource
/#X-Amz-Target=AWSWAF_20190729.TagResourceAssociates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for… - POSTUntag resource
/#X-Amz-Target=AWSWAF_20190729.UntagResourceDisassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the… - POSTUpdate iP set
/#X-Amz-Target=AWSWAF_20190729.UpdateIPSetUpdates the specified IPSet . This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you… - POSTUpdate managed rule set version expiry date
/#X-Amz-Target=AWSWAF_20190729.UpdateManagedRuleSetVersionExpiryDateUpdates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate… - POSTUpdate regex pattern set
/#X-Amz-Target=AWSWAF_20190729.UpdateRegexPatternSetUpdates the specified RegexPatternSet . This operation completely replaces the mutable specifications that you already have for the regex pattern set with the… - POSTUpdate rule group
/#X-Amz-Target=AWSWAF_20190729.UpdateRuleGroupUpdates the specified RuleGroup . This operation completely replaces the mutable specifications that you already have for the rule group with the ones that… - POSTUpdate web aCL
/#X-Amz-Target=AWSWAF_20190729.UpdateWebACLUpdates the specified WebACL . While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. This…
API details
- Base URL
https://wafv2.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 59 operations on 59 pathsPOST 59
- Description format
- AWS Smithy model, API version
2019-07-29 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS WAFV2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS WAFV2 collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate web aCL” (POST /#X-Amz-Target=AWSWAF_20190729.AssociateWebACL), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS WAFV2?
WAF This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and… It is listed under Developer tools and has 59 endpoints.
Who publishes the AWS WAFV2?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS WAFV2?
Requests go to https://wafv2.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS WAFV2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS WAFV2 have?
59 operations on 59 paths (59 POST).
Is forking the AWS WAFV2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.