Field | Description |
Name | Name of the plan. |
Version | Version assigned for the plan. |
Team | Team to which the application must be assigned to. You can select more than one team. To remove a team, click the icon next to the team. |
Description | A brief description for the plan. |
Icon | An icon that is displayed for the plan. Click Browse and select the required image to be displayed as the icon for the plan. The icon size should not be more than 100 KB. |
Field | Description |
Name | Name of the custom field. |
Field Value | Value for the custom field. |
Description | A brief description for the custom field. |
Field | Description |
Cost | Specifies the cost for the plan. |
Terms | Specifies the terms of conditions for the pricing. |
License | Specifies the license information. |
Field | Description |
Maximum request count | Specifies the maximum number of requests handled. Value provided should be an integer. |
Interval | Specifies the value for the interval for which the maximum request count is handled. Value provided should be an integer. |
Interval unit | Specifies the unit of measurement of the time interval. For example: Minutes Hours Days Calendar Week. The plan starts on the first day of the week and ends on the last day of the week. By default, the start day of the week is set to Monday. For example: If you subscribe to a package on a Wednesday and Interval is set to 1, the validity of the plan ends on Sunday, that is, 5 days. If you subscribe to a package on a Wednesday and Interval is set to 2, the validity of the plan still ends on Sunday, but the validity of the plan is two calendar weeks, that is 12 days. You can change the start day of the week using the extended setting startDayOfTheWeek in the Administration > General > Extended settings section. Restart the API Gateway server for the changes to take effect. Calendar Month. Starts on the first day of the month and ends on the last day of the month. For example: If you subscribe to a package in the month of August and Interval is set to 1, the validity of the plan ends on the last day of August. If you subscribe to a package in the month of August and Interval is set to 2, the validity of the plan ends in two calendar months, that is on the last day of September. |
Alert frequency | Specifies how frequently to send alerts to API Gateway destination when the Rate limits condition is violated. Select one of the options: Only Once. Triggers an alert only the first time one of the specified conditions is violated. Every Time. Triggers an alert every time one of the specified conditions is violated. |
Violation message | Specifies the text that appears when the rule is violated. |
Field | Description |
Maximum request quota | Specifies the maximum number of requests handled. Value provided should be an integer. |
Block on breach | When selected, it specifies that the access to the API is blocked when there is a rule violation. Also, a notification is sent to API Gateway destination depending on the Alert frequency. By default, this option is not selected. |
Interval | Specifies the value for the interval for which the maximum request quota is handled. Value provided should be an integer. |
Interval unit | Specifies the unit of measurement of the time interval. For example: Minutes Hours Days Calendar Week. The plan starts on the first day of the week and ends on the last day of the week. By default, the start day of the week is set to Monday. For example: If you subscribe to a package on a Wednesday and Interval is set to 1, the validity of the plan ends on Sunday, that is, 5 days. If you subscribe to a package on a Wednesday and Interval is set to 2, the validity of the plan still ends on Sunday, but the validity of the plan is two calendar weeks, that is 12 days. You can change the start day of the week using the extended setting startDayOfTheWeek in the Administration > General > Extended settings section. Restart the API Gateway server for the changes to take effect. Calendar Month. Starts on the first day of the month and ends on the last day of the month. For example: If you subscribe to a package in the month of August and Interval is set to 1, the validity of the plan ends on the last day of August. If you subscribe to a package in the month of August and Interval is set to 2, the validity of the plan ends in two calendar months, that is on the last day of September. |
Alert frequency | Specifies how frequently to send alerts to API Gateway destination when the Quota condition is violated. Select one of the options: Only Once. Triggers an alert only the first time one of the specified conditions is violated. Every Time. Triggers an alert every time one of the specified conditions is violated. |
Violation message | Specifies the text that displays when the policy is violated. |
Notification settings | Specifies whether notifications are to be sent on rule violations. Enable the toggle button to enable the notifications and provide the following information: Notify after (in %). Provide a value which is a number. A notification is sent to the configured email IDs once the total request count reaches the % value as provided in the maximum quota value. Violation message. Provide the content of the mail that is sent to the configured email Ids once the quota request count reaches the limit specified. Email Ids. Provide an email Id of the recipient to which notifications have to be sent once the quota request count reaches the limit specified. Click to add multiple recipients. Note: The SMTP settings under Administrator settings > Destinations has to be provided for an email to be sent. Send Digital Events Custom destination. Select custom destinations to which the notification must be sent. You can select multiple custom destinations. The custom destinations displayed in this field are populated from the custom destinations, configured in the Administration > Destinations > Custom destinations page. |