Published On: August 6ᵗʰ, 2019 02:11

API Reference for Cisco Enterprise Network Function Virtualization Infrastructure Software

Introduction to Cisco Enterprise NFVIS REST APIs

REST API Credentials

Ensure you include the following credential information in REST API requisition:

  • User name: admin

  • Password: password for admin

The payload in request can be in XML or JSON format. The headers (Content-Type and Accept) must be set accordingly.

The following two groups of headers are supported:
Table 1. Supported Headers

XML

Content-Type:application/vnd.yang.data+xml Accept:application/vnd.yang.data+xml

JSON

Content-Type:application/vnd.yang.data+json Accept:application/vnd.yang.data+json

API Request Methods

The following are the supported REST API request methods:

HTTP Request Method

Description

GET

Retrieves the specified resource or representation. GET is a read-only operation that does not change the engine state or have any side effects.

Note 

The GET method supports "?deep" query to get more detailed information.

POST

Submits data to be processed to the specified resource. The data to be processed is included in the request body. A POST operation can create a new resource.

PUT

Updates the specified resource with new information. The data that is included in the PUT operation replaces the previous data.

  • The PUT operation is used to replace or modify an existing resource. The PUT operation cannot be used to create a new resource.

  • The request body of a PUT operation must contain the complete representation of the mandatory attributes of the resource.

DELETE

Deletes a resource. If you delete a resource that has already been deleted, a 404 Not Found response is returned.


Note

You can use any command line tool, such as curl, that supports transferring of data using the HTTPS protocol. All REST API commands must be preceded by https://<host_server_ip> . This is the Cisco Enterprise NFVIS host IP address.