TooManyRequestsHttpException

API reference › yii › web › TooManyRequestsHttpException

class	yii\web\TooManyRequestsHttpException
Extends	HttpException » yii\base\UserException » yii\base\Exception » Exception
Since	2.0
Source	framework/web/TooManyRequestsHttpException.php

TooManyRequestsHttpException represents a “Too Many Requests” HTTP exception with status code 429.

Use this exception to indicate that a client has made too many requests in a given period of time. For example, you would throw this exception when ‘throttling’ an API user.

See also: https://tools.ietf.org/html/rfc6585#section-4.

Properties

Property	Type	Description	Defined by
$statusCode	int	HTTP status code, such as 403, 404, 500, etc. Default: null.	HttpException

Methods

Method	Description	Defined by
__construct()	Constructor.	TooManyRequestsHttpException
getName()		HttpException

Method details

__construct()

public function __construct(string|null $message = null, int $code = 0, Throwable|null $previous = null)

Constructor.

Parameters

Parameter	Type	Description
$message	string|null	Error message
$code	int	Error code
$previous	Throwable|null	The previous exception used for the exception chaining.