Configure API Rate Limiting

• From the Console homepage, click on Load Balancers service.

• Select your namespace.

• Navigate to Manage > Load Balancers > HTTP Load Balancers.

• Click ... for your load balancer and select Manage Configuration to open load balancer configuration form.

• Click Edit Configuration option located in the top right corner of the form.

• Go to Security Configuration and enable Show Advanced Fields option.

• Scroll down, click on the Rate Limiting field and select API Rate Limit option.

• Optionally, click on the IP(s) Allowed without Rate Limiting field and do one of the following to exclude IP addresses from rate limiting:

  • Select IP Allowed List and enter IP addresses in the List of IPv4 Prefix List field. You can add more than one using the Add item option.

  • Select IP Allowed List using IP Prefix Set(s) and select IP prefix sets in the List of IP Prefix Sets field. You can add more than one using the Add item option. For this, at least one pre-configured IP prefix set is required.

Note: No IP addresses are allowed by default for the IP(s) Allowed without Rate Limiting field.

The server URL rules apply rate limiting for an entire domain or base path that contains multiple API endpoints.

Click Add Item in the Server URLs section and do the following in the ServerUrlRule form:

• Click on the Domain field and select either Any Domain or Specific Domain. In case of specific domain, enter the domain in the Specific Domain field. Default option is Any Domain.

• Click on the Base Path field and enter a base path.

Note: Click on the Base Path field and click See Suggestions to display suggested list of paths. This shows suggestions only if you have configured an API definition. To know how to create and configure API definition, see Import Swagger and Define APIs.

• Click on the Rate Limiter Values field and do one of the following:

  • Select Specific Valuesand do the following:

    • Enter a number for the Threshold field. This threshold represents the number of allowed requests for the time period set in the Duration field.
    • The Count By field sets the HTTP load balancer user identifier for the client identification. You can change this to use a custom user identification. Select User Identification Policy for the Count By field, click on the User Identification Policy field, and select an existing user identification policy or use the Create new User Identification option to create and apply a new user identification policy.

  • Select External Rate Limiter, click on the External Rate Limiter field, and select an existing rate limiter. Alternatively, you can also use the Create new Rate Limiter option to create a new rate limiter and apply it here.

Note: See Configure Rate Limiting guide for instructions on how to create rate limiter and user identifiers.

• Click Add Item to add the server URL rule. Use the Add Item in the Server URLs to add more rules.

Note: The rules are processed in the order in which you configure the server rules. The first rule matching the request triggers rate limiting and rest of the rules after that are not executed. Therefore, ensure you set the order of rules as per your requirements.

The API endpoint rules apply rate limiting for specific endpoints.

Click Add Item in the API Endpoints section and do the following in the ApiEndpointRule form:

• Click on the Domain field and select either Any Domain or Specific Domain. In case of specific domain, enter the domain in the Specific Domain field. Default option is Any Domain.

• Click on the Base Path field and enter a base path.

• Click on the API Endpoint field and enter a specific API endpoint path.

Note: Click on the Base Path and API Endpoint fields and click See Suggestions to display suggested list of paths and endpoints respectively. The suggestions are shown only if you have configured an API definition. To know how to create and configure API definition, see Import Swagger and Define APIs.

• Click on the Method List field under HTTP Methods and select the methods for which the rate limiting is to be applied. You can select more than one method.

• Click on the Rate Limiter Values field and do one of the following:

  • Select Specific Valuesand do the following:

    • Enter a number for the Threshold field. This threshold represents the number of allowed requests for the time period set in the Duration field.
    • The Count By field sets the HTTP load balancer user identifier for the client identification. You can change this to use a custom user identification. Select User Identification Policy for the Count By field, click on the User Identification Policy field, and select an existing user identification policy or use the Create new User Identification option to create and apply a new user identification policy.

  • Select External Rate Limiter, click on the External Rate Limiter field, and select an existing rate limiter. Alternatively, you can also use the Create new Rate Limiter option to create a new rate limiter and apply it here.

Note: See Configure Rate Limiting guide for instructions on how to create rate limiter and user identifiers.

• Click Add Item to add the server URL rule. Use the Add Item in the ApiEndpointRule to add more rules.

Note: The rules are processed in the order in which you configure the API endpoint rules. The first rule matching the request triggers rate limiting and rest of the rules after that are not executed. Therefore, ensure you set the order of rules as per your requirements.

• Check the order of the rules you added.

• After you finish, click Save and Exit.