View a markdown version of this page

ApiPattern - AWS WAFV2

ApiPattern

An API endpoint pattern that an API security event involves.

Contents

Domains

The domains that the API pattern was observed on. For example, api.example.com.

Type: Array of strings

Array Members: Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Method

The HTTP method of the API pattern. For example, GET or POST.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 16.

Required: No

PathPattern

The normalized URI path of the API pattern. Templated path segments are shown in braces. For example, /api/v1/accounts/{id}.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

Port

The port of the API pattern. For example, 443.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: