Chapter 1. Overview

- Getting Started with Cisco DCNM APIs

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.

Accessing the DCNM REST API documentation involves the following steps:

1. Log in to your Cisco DCNM Web Client.

2. Go to the URL: https://DCNM-IP/api-docs

The following figure shows the DCNM REST API documentation.

Cisco DCNM REST API Documentation

Note

The Cisco DCNM REST API documentation only works from Cisco DCNM Release 10.2(1).

The REST API documentation packaged with the Cisco DCNM is limited to the following API categories:

- PMN

- LAN Fabric Provisioning

- Session Management

- DCNM Storage

- DCNM Performance

- DCNM Discovery

- DCNM Inventory

- DCNM Connect

- Resource Manager Operations

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. The following figure shows the APIs in the DCNM Inventory category.

APIs in the DCNM Inventory Category

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.

The following figure shows how the GET API method is used:

GET API Method

The following figure shows the response of the GET API method:

Response of GET API Method

For more information about the Cisco DCNM REST APIs, see https://developer.cisco.com/docs/cisco-dcnm-rest-api-reference-guide-release-11-2-1/

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: https://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1721R)