Modify a quota policy

put

https://{hostname}/appsec/v1/configs/{configId}/versions/{versionNumber}/quota-policies/{quotaPolicyId}

All products Update an existing quota policy. Include the lockVersion from the current quota policy object to prevent conflicting concurrent modifications.

Path Params

configId

int64

required

A unique identifier for each configuration.

versionNumber

integer

required

A unique identifier for each version of a configuration.

quotaPolicyId

int64

required

Specify a unique identifier for each quota policy.

Query Params

accountSwitchKey

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.

description

string

Provide descriptive text about a quota policy.

failResponseAction

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:

interval

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:

lockVersion

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.

matchType

string

enum

required

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

Allowed:

name

string

required

Specify the name you assign to a quota policy.

quota

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

200Successfully updated quota policy.

400Bad request. Invalid request body or URL parameter input.

403Forbidden. You don't have access to quota policies in this security configuration.

404Not found. Security configuration version or quota policy wasn't found.