Skip to content

Add-PodeLimitRule

SYNOPSIS

Adds rate limiting rules for an IP addresses, Routes, or Endpoints.

SYNTAX

Add-PodeLimitRule [-Type] <String> [-Values] <String[]> [-Limit] <Int32> [-Seconds] <Int32> [-Group]
 [<CommonParameters>]

DESCRIPTION

Adds rate limiting rules for an IP addresses, Routes, or Endpoints.

EXAMPLES

EXAMPLE 1

Add-PodeLimitRule -Type IP -Values '127.0.0.1' -Limit 10 -Seconds 1

EXAMPLE 2

Add-PodeLimitRule -Type IP -Values @('192.168.1.1', '10.10.1.0/24') -Limit 50 -Seconds 1 -Group

EXAMPLE 3

Add-PodeLimitRule -Type Route -Values '/downloads' -Limit 5 -Seconds 1

PARAMETERS

-Group

If supplied, groups of IPs in a subnet will be considered as one IP.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Limit

The maximum number of requests to allow.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Seconds

The number of seconds to count requests before restarting the count.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Type

What type of request is being rate limited: IP, Route, or Endpoint?

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Values

A single, or an array of values.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES