Skip to main content

Get Rate Limit

Retrieve rate limit for website acceleration service.

Request

Request-Line

GET /waap/v1.0/services/{serviceId}/rateLimit HTTP/1.1

Request Parameters

Path Parameters

ParameterTypeRequiredDescription
serviceIdIntegerMandatoryService ID.

Response

Response Body

ParameterTypeRequiredDescription
timeFrameIntegerOptionalTime to apply the limit (in seconds).
reqLimitIntegerOptionalThe maximum number of requests allowed from the same user IP within the specified time frame.
ignorePathBooleanOptionalIgnore URLs, apply a single limit for all URLs from the same user IP.
ignoreQueryBooleanOptionalIgnore Query String when counting requests.

Status Codes, Error Codes and Error Messages

Status CodeError CodeError Message
400ServiceId.InvalidServiceId is empty or invalid.
400RateLimit.OperationFailedThe rate limit operation failed.
404ServiceId.NotFoundServiceId is not found.

Examples

Get Rate Limit

Request

GET /waap/v1.0/services/12345/rateLimit HTTP/1.1

Successful Response Body

{
"timeFrame": 60,
"reqLimit": 100,
"ignorePath": true,
"ignoreQuery": true
}