Cisco Catalyst SD-WAN Control Components and Device Management Guide, Releases 26.x and Later

PDF

Rate limit for bulk API requests

Updated: June 9, 2026

Want to summarize with AI?

Describes the rate limit that applies to bulk API requests.

In Cisco vManage Release 20.9.x and earlier releases, you send bulk API requests to a specific node in an SD-WAN Manager cluster. The bulk API throughput is constrained by the rate-limit per node. Increasing the throughput requires sending separate bulk API requests to each node in the cluster and collating the API responses.

From Cisco vManage Release 20.10.1, the method is to send bulk API requests to the SD-WAN Manager cluster. SD-WAN Manager distributes the API requests among the clusters in the node. This distribution increases the rate limit to:

(rate-limit per node) * (number of nodes in the cluster)

This allows you to retrieve more data in a shorter duration compared to a bulk API request addressed to a single node. With the distribution, you need not send separate bulk API requests to two or more nodes in the cluster or collate the API responses.

Configure the rate limit for bulk API requests, using CLI commands

Configure the rate limit for bulk API requests.

Before you begin

Follow these steps to configure the rate limit for bulk API requests.

Procedure

	1.	Log in to one of the Cisco SD-WAN Manager nodes in the SD-WAN Manager cluster and execute the request nms server-proxy set ratelimit command. `sdwan-manager# request nms server-proxy set ratelimit`
	2.	When prompted with this: `Do you want to reconfigure rate limit for URL non bulk api [y/n] :` Enter n .
	3.	When prompted with this: `Do you want to reconfigure rate limit for URL bulk api /dataservice/data/device/statistics [y/n] :` Enter y .
	4.	Enter the per-node rate limit in response to a prompt similar to this: `Enter the PER NODE rate limit for URL bulk api /dataservice/data/device/statistics [144 load balanced across all nodes at present] :` In this example, there is a three-node SD-WAN Manager cluster, with the bulk API rate limit configured to the default value of 48 requests per node. Across all the three nodes, the bulk API rate limit is (rate-limit/node) * 3, which is 144 requests. Before you enter the rate limit, consider its effect on SD-WAN Manager resources.
	5.	Enter the unit time for which the rate limit applies in response to a prompt similar to this: `Enter the rate limit unit (second, minute, hour, day) for URL bulk api /dataservice/data/device/statistics [minute] :` You can apply a rate limit per second, minute, hour, or day. The default unit is minute. While SD-WAN Manager applies the rate limit to all the SD-WAN Manager instances in the cluster, the command line displays this message: `Propagating rate limit update across all nodes. Please wait.` After the rate limit is applied, SD-WAN Manager prompts you to restart the server-proxy on all nodes and the command line returns to the privileged EXEC mode: `Done. Please restart server-proxy on all nodes using "request nms server-proxy restart" command.`
	6.	Restart the server-proxy using the request nms server-proxy restart command. `sdwan-manager# request nms server-proxy restart`
	7.	Log in to the other SD-WAN Manager nodes in the cluster and restart the server-proxy using the request nms server-proxy restart command.

In this example, the bulk API rate limit per node is set to 50 requests per minute.

sdwan-manager# request nms server-proxy set ratelimit
Do you want to reconfigure rate limit for URL non bulk api [y/n] : n
Do you want to reconfigure rate limit for URL bulk api /dataservice/data/device/statistics [y/n] : y
Enter the PER NODE rate limit for URL bulk api /dataservice/data/device/statistics [144 load balanced across all nodes at present] : 50
Enter the rate limit unit (second, minute, hour, day) for URL bulk api /dataservice/data/device/statistics [minute] : minute
Propagating rate limit update across all nodes. Please wait.
Done. Please restart server-proxy on all nodes using "request nms server-proxy restart" command.
vManage# request nms server-proxy restart

Need help?

Open a support case

(Requires a Cisco Service Contract)

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.