The REST API plug-in supports the JavaScript Object Notation (JSON) format for a response. For JSON response, specify Accept: application/json in the HTTP header as shown in the following example:

GET /api/vc/summary HTTP/1.1
Host: 10.10.10.2
Accept: application/json
Authorization: Basic YWRtaW46U2Zpc2gxMjM=

To specify the JSON response format through cURL, use the following:

curl -u <user>:<password> <vsm-ip>/api/port-profile -H "Accept: application/json"

The following example shows the response received in the JSON format:

HTTP/1.1 200 OK
Date: Wed, 21 Aug 2013 19:33:56 GMT
Content-Type: application/json; charset=utf-8
{
    "": {
        "url": "/api/vc/summary",
        "properties": {
            "vcStatus": "Connected",
            "vcIpaddress": "10.10.10.4",
            "switchMode": "Advanced",
            "ip": "10.10.10.2",
            "vcUuid": "12 57 2f 50 07 e8 b4 ea-1c 0e ba 78 23 52 96 3e",
            "name": "n1kv-cy",
            "datacenterName": "Sample-DC",
            "haStatus": true,
            "mode": "L3",
            "version": "version 4.2(1u)SV2(2.1au) [build 4.2(1)SV2(2.1a)]",
            "connectionName": "vcenter"
        }
    }
}

The REST API plug-in supports the XML format for a response. For XML response, specify Accept: application/xml in the HTTP header as shown in the following example:

GET /api/vc/summary HTTP/1.1
Host: 10.10.10.2
Accept: application/xml
Authorization: Basic YWRtaW46U2Zpc2gxMjM=

To specify the XML response format through cURL, use the following:

curl -u <user>:<password> <vsm-ip>/api/port-profile -H "Accept: application/xml"

The following example shows the response received in the XML format:

<?xml version="1.0" encoding="utf-8"?>
<instance url="/api/vc/summary">
    <properties>
        <vcStatus>Connected</vcStatus>
        <vcIpaddress>10.10.10.4</vcIpaddress>
        <switchMode>Advanced</switchMode>
        <ip>10.10.10.2</ip>
        <vcUuid>12 57 2f 50 07 e8 b4 ea-1c 0e ba 78 23 52 96 3e</vcUuid>
        <name>n1kv-cy</name>
        <datacenterName>Sample-DC</datacenterName>
        <haStatus>true</haStatus>
        <mode>L3</mode>
        <version>version 4.2(1u)SV2(2.1au) [build 4.2(1)SV2(2.1a)]</version>
        <connectionName>vcenter</connectionName>
    </properties>
</instance>

The GET method lists the entities in a specific resource. The format of the GET method is as follows:

/api/<resource>

The following is an example of the GET method in cURL:

curl -u admin:password 10.10.10.2/api/port-profile/profile1 -H "Accept: application/json"

{
  "profile1": {
    "url": "\/api\/port-profile\/profile1",
    "properties": {
      "minPorts": 1,
      "description": "",
      "switchportMode": "trunk",
      "state": false,
      "name": "profile1",
      "portBinding": "static",
      "portGroupName": "",
      "capability": "",
      "maxPorts": 32,
      "type": "Vethernet"
    }
  }
}

The POST method creates a new instance of a resource or updates the identified instance. To create a new resource, the format of the POST method is as follows:

/api/<resource>

The following is an example of the POST method to create an instance of a resource in cURL:

curl -X POST -u admin:password 10.10.10.2/api/port-profile -d '{ "name" : "profile1", "switchportMode" : "access", "shutdown" : "false"}'

Successfully created "port-profile profile1"

To modify a specific instance, the format of the POST method is as follows:

/api/<endpoint>/<instance>

The following is an example of the POST method to modify a specific instance in cURL:

curl -X POST -u admin:password 10.10.10.2/api/port-profile/profile1 -d '{ "switchportMode" : "trunk", "shutdown" : "false"}’

Successfully modified "port-profile profile1"

The DELETE method deletes the specified instance. The format of the DELETE method is as follows:

/api/<resource>/<instance>

The following is an example of the DELETE method in cURL:

curl -u admin:password -X DELETE 10.10.10.2/api/port-profile/profile1

Successfully deleted "port-profile profile1"

The APIs under /api/vc are used internally by the Cisco Nexus 1000V vCenter plug-in and are read-only. These APIs are changed according to the requirements of the Cisco Nexus 1000V vCenter plug-in.

To make the changes done for a resource (through POST or DELETE method) persistent, use the POST method to send an HTTP request to the following link:

http://vsm-ip/api/cli

Include the following in the request body:

{"cmd": "copy r s"}

To do the same using cURL, use the following command:

curl -u username:password 10.10.10.2/api/cli -d '{"cmd": "copy r s"}' -i