Edit a throttling counter

put

https://{hostname}/apikey-manager-api/v2/counters/{counterId}

Updates information about a throttling counter.

Path Params

counterId

int64

required

Identifies the throttling counter. Run the List throttling counters operation to select one.

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

errorResponse

object

Specifies the error response sent to users who reach the throttling limit.

headersConfig

object | null

Contains information about the criteria for sending the throttling limit and rate HTTP headers. This value may appear as null if you don't specify any throttling headers.

throttlingAlertThreshold

integer

70 to 98

Specifies a limit, set as a percentage between 70% and 98%, at which an alert triggers when system usage exceeds this percentage of capacity.

throttlingCounterDescription

string | null

Description you provide for the throttling counter. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as null.

throttlingCounterEnabled

boolean

required

Enables the throttling counter.

throttlingCounterName

string

required

length between 1 and 200

Name you provide for the throttling counter.

throttlingLimit

integer

required

10 to 1000000

Value of the request-per-second limit related to the throttling counter. It applies to the entire Akamai edge network. If the request count reaches the defined limit, API Gateway rejects any excessive requests with a 429 response until the moving average for this throttling counter diminishes to the set threshold. This usually takes up to ten seconds.

throttlingLimitExceededAction

string

enum

required

Instruction for edge servers on how to handle excessive requests when a throttling limit is reached. Either DENY to reject excessive requests, or WARN to send an alert when excessive requests reach edge servers.

Allowed:

throttlingRules

object | null

Specifies a set of throttling conditions that cause the throttling counter to increment. This value may appear as null if you don't specify any conditions.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The response returns the updated counter.

400Bad request. The request contains invalid data.

401Unauthorized. You are not authorized to perform the action.

403Forbidden. You don't have permission to the resource.

404Not found. The resource doesn't exist.

405Method not allowed.

500Internal server error.