Skip to main content

SD-WAN - Programmatic APIs

image.png

Cisco Catalyst SD-WAN software provides a REST API, a programmatic interface for controlling, configuring, and monitoring the Cisco Catalyst SD-WAN devices in an overlay network. You can access the REST API through the Cisco Catalyst SD-WAN Manager web server.

The main characteristics of the programmatic APIs are as follows:

  • Programmatic control over all aspects of SD-WAN Manager administration
  • Secure HTTPS interface
  • GET, PUT, POST, DELETE methods
  • Authentication and authorization
  • Bulk API calls
  • Python scripting

The Cisco Catalyst SD-WAN REST API allows you to attach and detach templates in an automated way across any size of fabric. You can modify fabric policies dynamically and automatically while allowing the integration of third-party monitoring solutions.

A REST API is a web service API that adheres to the REST architecture. The REST architecture uses a stateless, client-server, cacheable communications protocol.

The SD-WAN Manager web server uses HTTP and its secure counterpart, HTTPS, as the communications protocol. REST applications communicate by using standard HTTP methods (GET, PUT, POST, DELETE) to make calls between network devices.

REST is a simpler alternative to mechanisms such as remote procedure calls (RPCs) and web services such as Simple Object Access Protocol (SOAP) and Web Services Description Language (WSDL). The REST architecture has not been formally defined by any standards bodies. While REST is not a standard, there are some guidelines and conventions that have been widely adopted. These include building on top of the standards of HTTP, naming resources as nouns, and popular data formats.