Home
...
Interceptor addition (ssd api-management add api-interceptor)
Rate Limit Interceptor Addition (ssd api-management add (plan | api)-interceptor rate-limit)

Rate Limit Interceptor Addition (ssd api-management add (plan | api)-interceptor rate-limit)

The `ssd api-management add (plan | api)-interceptor rate-limit` command allows you to add a "Rate Limit" interceptor to an API or plan flow on Sensedia API Platform.

NOTE
You can use the ssd api-management add (plan | api)-interceptor rate-limit command or its shortened version ssd apim add (plan | api)-interceptor rate-limit.

Usage

The ssd api-management add (plan | api)-interceptor rate-limit command can be followed by flags with their corresponding arguments:

If no flag is specified, the interactive mode will be activated.

Below you will find usage examples in the direct mode:

Available Flags

The following flags can be used with the ssd (api-management | apim) add (plan | api)-interceptor rate-limit command:

Flag	Type	Description
Flags for APIs
-n, --api-name	string	API name to which the interceptor will be added
-s, --revision	string	API revision to which the interceptor will be added
-v, --api-version	string	API version to which the interceptor will be added
Flags for plans
-n, --plan-name	string	Plan name to which the interceptor will be added
Other flags
--calls	int	Total number of accepted calls
-f, --flow	string	API or plan flow to which the interceptor will be added (INBOUND or OUTBOUND)
-h, --help		Displays help for the command
-i, --interval	string	Time interval to be considered. Available options: "SECOND", "MINUTE", "HOUR", "DAY", "MONTH"
--quota-header		Instructs the gateway to insert a header parameter informing the number of remaining calls
--soft		Selects the "Soft Limit" option
--soft-value	int	Specifies an additional percentage of allowed calls
-m, --method	string	Method (operation) to which the interceptor will be added (Optional). E.g.: POST
-a, --path	string	Operation path to which the interceptor will be added (Optional). E.g.: /users
-p, --position	int	Position of the interceptor in the API or plan flow
-r, --resource	string	Resource name to which the interceptor will be added (Optional)

Global Flags

Flag	Type	Description
-c, --config	string	Configuration file (default: `$HOME/.sensedia/config.json`)
--profile	string	The configuration profile you want to use (default: "default")
--verbose		Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: `$ ssd (api-management \| apim) list apis --verbose 2> log.txt`

How happy are you with this page?

Payload Size Interceptor Addition (ssd api-management add (plan | api)-interceptor payload-size)

Restrict Access Interceptor Addition (ssd api-management add (plan | api)-interceptor restrict)