API
  1. Configuration settings
  2. Shared resources: Quota policies

Create a quota policy

post
https://{hostname}/appsec/v1/configs//versions//quota-policies

All products Create a new quota policy for a specific configuration version. Set matchType to path to apply the quota to website path traffic or api to apply it to API endpoint traffic. For api type policies, include apiSelectors to specify which API endpoints and resources to target.

Path Params
int64
required

A unique identifier for each configuration.

integer
required

A unique identifier for each version of a configuration.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Review details about a quota policy.

apiSelectors
array of objects

The API endpoints to match in incoming requests. Only applies when matchType is api.

apiSelectors
clientIdentifiers
array

Client identifiers used to track individual request senders. The first identifier in the list is the primary one. If the primary identifier cannot be resolved, the next one in the list is used.

clientIdentifiers
conditions
object

Enhanced match conditions that further filter which requests count toward the quota. When present, only requests that satisfy all conditions are counted.

string

Provide descriptive text about a quota policy.

string
enum

Specify the action to take when the quota check fails, either alert to log the event or none to take no action.

Allowed:
string
enum
required

The time interval over which to count requests toward the quota limit. Either ONE_HOUR, THREE_HOURS, SIX_HOURS, TWELVE_HOURS, or TWENTY_FOUR_HOURS.

Allowed:
int64

The optimistic locking version of the quota policy. Include this value in PUT requests to prevent conflicting concurrent updates. See Concurrency control for details.

string
enum
required

Specify the match type for this quota policy, either path to match website paths or api to match API endpoints.

Allowed:
string
required

Specify the name you assign to a quota policy.

integer
required
≥ 1

The maximum number of requests allowed within the specified interval.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 4 hours ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated about 4 hours ago

Did this page help you?