Skip to content

AWS WAFV2 API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>WAF</fullname> <note> <p>This is the latest version of the <b>WAF</b> 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.</p> <p>If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces. </p> <p>For information, including how to migrate your WAF resources to this version, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p> </note> <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, or App Runner service. 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. </p> <p>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 <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer Guide</a>.</p> <p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p> <ul> <li> <p>For regional applications, 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, or an App Runner service. </p> </li> <li> <p>For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.</p> </li> </ul> <p>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 <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:</p> <ul> <li> <p>You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a <code>Scope</code> parameter and set it to <code>CLOUDFRONT</code> or <code>REGIONAL</code>. </p> </li> <li> <p>You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.</p> </li> <li> <p>The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.</p> </li> </ul>

AWS WAFV2 is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 51 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2019-07-29
Endpoints
51
Spec updated
2020-03-31

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AWSWAF_20190729.AssociateWebACL<p>Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amaz
POST/#X-Amz-Target=AWSWAF_20190729.CheckCapacity<p>Returns 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 rule
POST/#X-Amz-Target=AWSWAF_20190729.CreateAPIKey<p>Creates an API key for use in the integration of the CAPTCHA API in your JavaScript client applications. The integration lets you customize the placement and
POST/#X-Amz-Target=AWSWAF_20190729.CreateIPSetCreates an <a>IPSet</a>, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're rece
POST/#X-Amz-Target=AWSWAF_20190729.CreateRegexPatternSetCreates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have WAF inspect a web request component for the specifi
POST/#X-Amz-Target=AWSWAF_20190729.CreateRuleGroup<p>Creates a <a>RuleGroup</a> per the specifications provided. </p> <p> A rule group defines a collection of rules to inspect and control web requests that you
POST/#X-Amz-Target=AWSWAF_20190729.CreateWebACL<p>Creates a <a>WebACL</a> per the specifications provided.</p> <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rul
POST/#X-Amz-Target=AWSWAF_20190729.DeleteFirewallManagerRuleGroups<p>Deletes all rule groups that are managed by Firewall Manager for the specified web ACL. </p> <p>You can only use this if <code>ManagedByFirewallManager</code
POST/#X-Amz-Target=AWSWAF_20190729.DeleteIPSetDeletes the specified <a>IPSet</a>.
POST/#X-Amz-Target=AWSWAF_20190729.DeleteLoggingConfigurationDeletes the <a>LoggingConfiguration</a> from the specified web ACL.
POST/#X-Amz-Target=AWSWAF_20190729.DeletePermissionPolicy<p>Permanently deletes an IAM policy from the specified rule group.</p> <p>You must be the owner of the rule group to perform this operation.</p>
POST/#X-Amz-Target=AWSWAF_20190729.DeleteRegexPatternSetDeletes the specified <a>RegexPatternSet</a>.
POST/#X-Amz-Target=AWSWAF_20190729.DeleteRuleGroupDeletes the specified <a>RuleGroup</a>.
POST/#X-Amz-Target=AWSWAF_20190729.DeleteWebACL<p>Deletes the specified <a>WebACL</a>. </p> <p>You can only use this if <code>ManagedByFirewallManager</code> is false in the specified <a>WebACL</a>. </p> <no
POST/#X-Amz-Target=AWSWAF_20190729.DescribeManagedRuleGroupProvides high-level information for a managed rule group, including descriptions of the rules.
POST/#X-Amz-Target=AWSWAF_20190729.DisassociateWebACL<p>Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regio
POST/#X-Amz-Target=AWSWAF_20190729.GenerateMobileSdkReleaseUrl<p>Generates a presigned download URL for the specified release of the mobile SDK.</p> <p>The mobile SDK is not generally available. Customers who have access t
POST/#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.
POST/#X-Amz-Target=AWSWAF_20190729.GetIPSetRetrieves the specified <a>IPSet</a>.
POST/#X-Amz-Target=AWSWAF_20190729.GetLoggingConfigurationReturns the <a>LoggingConfiguration</a> for the specified web ACL.
POST/#X-Amz-Target=AWSWAF_20190729.GetManagedRuleSet<p>Retrieves the specified managed rule set. </p> <note> <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and A
POST/#X-Amz-Target=AWSWAF_20190729.GetMobileSdkRelease<p>Retrieves information for the specified mobile SDK release, including release notes and tags.</p> <p>The mobile SDK is not generally available. Customers who
POST/#X-Amz-Target=AWSWAF_20190729.GetPermissionPolicy<p>Returns the IAM policy that is attached to the specified rule group.</p> <p>You must be the owner of the rule group to perform this operation.</p>
POST/#X-Amz-Target=AWSWAF_20190729.GetRateBasedStatementManagedKeys<p>Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based r
POST/#X-Amz-Target=AWSWAF_20190729.GetRegexPatternSetRetrieves the specified <a>RegexPatternSet</a>.
POST/#X-Amz-Target=AWSWAF_20190729.GetRuleGroupRetrieves the specified <a>RuleGroup</a>.
POST/#X-Amz-Target=AWSWAF_20190729.GetSampledRequests<p>Gets 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
POST/#X-Amz-Target=AWSWAF_20190729.GetWebACLRetrieves the specified <a>WebACL</a>.
POST/#X-Amz-Target=AWSWAF_20190729.GetWebACLForResourceRetrieves the <a>WebACL</a> for the specified resource.
POST/#X-Amz-Target=AWSWAF_20190729.ListAPIKeysRetrieves a list of the API keys that you've defined for the specified scope.
POST/#X-Amz-Target=AWSWAF_20190729.ListAvailableManagedRuleGroupVersionsReturns a list of the available versions for the specified managed rule group.
POST/#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 the
POST/#X-Amz-Target=AWSWAF_20190729.ListIPSetsRetrieves an array of <a>IPSetSummary</a> objects for the IP sets that you manage.
POST/#X-Amz-Target=AWSWAF_20190729.ListLoggingConfigurationsRetrieves an array of your <a>LoggingConfiguration</a> objects.
POST/#X-Amz-Target=AWSWAF_20190729.ListManagedRuleSets<p>Retrieves the managed rule sets that you own. </p> <note> <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services a
POST/#X-Amz-Target=AWSWAF_20190729.ListMobileSdkReleases<p>Retrieves a list of the available releases for the mobile SDK and the specified device platform. </p> <p>The mobile SDK is not generally available. Customers
POST/#X-Amz-Target=AWSWAF_20190729.ListRegexPatternSetsRetrieves an array of <a>RegexPatternSetSummary</a> objects for the regex pattern sets that you manage.
POST/#X-Amz-Target=AWSWAF_20190729.ListResourcesForWebACLRetrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon
POST/#X-Amz-Target=AWSWAF_20190729.ListRuleGroupsRetrieves an array of <a>RuleGroupSummary</a> objects for the rule groups that you manage.
POST/#X-Amz-Target=AWSWAF_20190729.ListTagsForResource<p>Retrieves the <a>TagInfoForResource</a> for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for pu
POST/#X-Amz-Target=AWSWAF_20190729.ListWebACLsRetrieves an array of <a>WebACLSummary</a> objects for the web ACLs that you manage.
POST/#X-Amz-Target=AWSWAF_20190729.PutLoggingConfiguration<p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided. </p> <note> <p>This operation co
POST/#X-Amz-Target=AWSWAF_20190729.PutManagedRuleSetVersions<p>Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.</p
POST/#X-Amz-Target=AWSWAF_20190729.PutPermissionPolicy<p>Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.</p> <p>You must be the owner of the rule group to perform t
POST/#X-Amz-Target=AWSWAF_20190729.TagResource<p>Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purpo
POST/#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 ta
POST/#X-Amz-Target=AWSWAF_20190729.UpdateIPSet<p>Updates the specified <a>IPSet</a>. </p> <note> <p>This operation completely replaces the mutable specifications that you already have for the IP set with th
POST/#X-Amz-Target=AWSWAF_20190729.UpdateManagedRuleSetVersionExpiryDate<p>Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expirat
POST/#X-Amz-Target=AWSWAF_20190729.UpdateRegexPatternSet<p>Updates the specified <a>RegexPatternSet</a>.</p> <note> <p>This operation completely replaces the mutable specifications that you already have for the regex
POST/#X-Amz-Target=AWSWAF_20190729.UpdateRuleGroup<p>Updates the specified <a>RuleGroup</a>.</p> <note> <p>This operation completely replaces the mutable specifications that you already have for the rule group
POST/#X-Amz-Target=AWSWAF_20190729.UpdateWebACL<p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. <

Questions

Does the AWS WAFV2 API need an API key?

Yes. The AWS WAFV2 API uses API key authentication; the documentation explains how to get credentials.

Does the AWS WAFV2 API support HTTPS?

Yes, the AWS WAFV2 API is served over HTTPS.

How many endpoints does the AWS WAFV2 API have?

Its OpenAPI description lists 51 endpoints in version 2019-07-29. All of them are shown on this page.

What are alternatives to the AWS WAFV2 API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).