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 DCNM Web Client, and go to the URL https://DCNM-IP/api-docs.
Note: Currently the REST API documentation (along with the Try It Out feature) packaged with the Cisco DCNM WebClient is limited to the following three 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, POST, PUT, and DELETE. You can fetch existing information or data from the DCNM server using the GET method; create new information or data using the POST method; delete data using the DELETE method; and update an existing record using the PUT method.
Status Codes
| Status Codes | Status | API's HTTPS Method or HTTPS Method |
|---|---|---|
| 200 | OK | GET |
| 202 | Accepted | POST PUT DELETE |
| 400 | Bad Request | GET POST PUT DELETE |
| 401 | Unauthorized | GET POST PUT DELETE |
| 403 | Forbidden | GET POST PUT DELETE |
| 404 | Not Found | GET POST PUT DELETE |
| 405 | Method Not Allowed | GET POST PUT DELETE |
| 500 | Internal Server Error | GET POST PUT DELETE |
The following chapters provide information about the Cisco DCNM APIs.