Hi,
The purpose of the API is to allow you to programmatically pull information from vManage (statistics, device status, device info, etc.) or manipulate vManage (change templates, delete, create new templates, etc.). Some use cases are:
- Network management systems (NMS) that pull vManage for data
- Backup and Recovery of vManage configuration templates, policies, etc.
Please note that if you controllers are Cisco-hosted, snapshots are taken of vManage often to help you restore everything in case of a disaster, but it never hurts to have another backup. There is a free tool provided by Cisco which "hides" the actual API calls and does them in the background while completing tasks like backup, restore, template creation, etc. for you. The tool is called Sastre and it is located here:
https://developer.cisco.com/codeexchange/github/repo/reismarcelo/sastre/
Here is the snippet from the site describing the tool:
"Sastre provides functions to assist with managing configuration elements and visualize information from Cisco SD-WAN deployments.
Some of the use-cases include:
- Transfer configuration from one vManage to another. E.g. Lab/POC to production, on-prem to cloud, etc.
- Backup, restore and delete configuration items. Tags and regular expressions can be used to select all or a subset of items.
- Visualize state across multiple devices. For instance, display status of control connections from multiple devices in a single table."
Hope it helps!
Steve
