Chapter 1. Getting Started with Cisco DCNM APIs

Chapter 1. Getting Started with Cisco DCNM APIs

Cisco DCNM provides REST APIs that allow third parties to test and develop application software. The REST API documentation is packaged with Cisco DCNM, and can be accessed through any browser. To view the Cisco DCNM REST API documentation, log in to your Cisco DCNM Web Client, and go to the URL:

https://DCNM-IP/api-docs

Note

The Cisco DCNM REST API documentation only works with Cisco DCNM 10.2(1) or later releases.

The REST API documentation packaged with the Cisco DCNM 10.2(1) WebClient is limited to the following API categories:

- • PMN

- • LAN Fabric Provisioning

- • Session Management

The APIs are grouped under broad categories, such as, DCNM PMN Host management and DCNM Session Management. In the DCNM RestFul API document, click the Show/hide button corresponding to any of the API category names displayed on the page. Alternatively, click on any category link to expand or collapse it. When a category is expanded, you can see the corresponding APIs under it.

There are 4 types of API methods:

- • GET—Fetch existing information or data from the DCNM server.

- • POST—Create new information or data.

- • DELETE—Delete existing information or data.

- • PUT—Update existing information or data.

For more information about the Cisco DCNM REST APIs, see Click Here