
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# POST vd

Creates a new virtual domain

Since Product Version: 3.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | POST

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

## Resource URL

/webacs/api/v1/op/vd

## Request Payload Parameters

Attribute | Description
--- | ---
accessPoints Long[] | IDs of access points associated with the virtual domain. Optional.
description String | Description of the virtual domain. Optional.
devices Long[] | IDs of devices associated with the virtual domain. Optional.
domainFQN String | Required Fully qualified name of the virtual domain
dynamicGroups String[] | FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional.
email String | Email address for sending alarms notifications. Optional.
groups String[] | FQNs of groups associated with the virtual domain. Optional.
siteMaps Long[] | IDs of site maps associated with the virtual domain. Optional.
timezone String | Time zone of the virtual domain. Optional.
virtualElements Long[] | IDs of virtual elements associated with the virtual domain. Optional.

## Response Parameters

Attribute | Description
--- | ---
warning String | An error message in case if any error occurred

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v1/op/vd

    <?xml version="1.0" ?>
    <vdFullDetailsDTO>
      <accessPoints>
        <accessPoints>15</accessPoints>
        <accessPoints>25</accessPoints>
      </accessPoints>
      <description>String value</description>
      <devices>
        <devices>15</devices>
        <devices>25</devices>
      </devices>
      <domainFQN>String value</domainFQN>
      <dynamicGroups>
        <dynamicGroups>String value</dynamicGroups>
        <dynamicGroups>Another string value</dynamicGroups>
      </dynamicGroups>
      <email>String value</email>
      <groups>
        <groups>String value</groups>
        <groups>Another string value</groups>
      </groups>
      <siteMaps>
        <siteMaps>15</siteMaps>
        <siteMaps>25</siteMaps>
      </siteMaps>
      <timezone>String value</timezone>
      <virtualElements>
        <virtualElements>15</virtualElements>
        <virtualElements>25</virtualElements>
      </virtualElements>
    </vdFullDetailsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/vd.json

    {
      "vdFullDetailsDTO" : {
        "accessPoints" : {
          "accessPoints" : [15,
          25]
        },
        "description" : "String value",
        "devices" : {
          "devices" : [15,
          25]
        },
        "domainFQN" : "String value",
        "dynamicGroups" : {
          "dynamicGroups" : ["String value",
          "Another string value"]
        },
        "email" : "String value",
        "groups" : {
          "groups" : ["String value",
          "Another string value"]
        },
        "siteMaps" : {
          "siteMaps" : [15,
          25]
        },
        "timezone" : "String value",
        "virtualElements" : {
          "virtualElements" : [15,
          25]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v1/op/vd

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v1/op">
      <vdopResultDTO>
        <warning>String value</warning>
      </vdopResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v1/op/vd.json

    {
      "mgmtResponse" : {
        "@responseType" : "operation",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/vd",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
        "vdopResultDTO" : {
          "warning" : "String value"
        }
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | POST

## Resource URL

/webacs/api/v2/op/vd

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
accessPoints Long[] | IDs of access points associated with the virtual domain. Optional.
description String | Description of the virtual domain. Optional.
devices Long[] | IDs of devices associated with the virtual domain. Optional.
domainFQN String | Required Fully qualified name of the virtual domain
dynamicGroups String[] | FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional.
email String | Email address for sending alarms notifications. Optional.
groups String[] | FQNs of groups associated with the virtual domain. Optional.
siteMaps Long[] | IDs of site maps associated with the virtual domain. Optional.
timezone String | Time zone of the virtual domain. Optional.
virtualElements Long[] | IDs of virtual elements associated with the virtual domain. Optional.

## Response Parameters

Attribute | Description
--- | ---
warning String | An error message in case if any error occurred

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v2/op/vd

    <?xml version="1.0" ?>
    <vdFullDetailsDTO>
      <accessPoints>
        <accessPoints>15</accessPoints>
        <accessPoints>25</accessPoints>
      </accessPoints>
      <description>String value</description>
      <devices>
        <devices>15</devices>
        <devices>25</devices>
      </devices>
      <domainFQN>String value</domainFQN>
      <dynamicGroups>
        <dynamicGroups>String value</dynamicGroups>
        <dynamicGroups>Another string value</dynamicGroups>
      </dynamicGroups>
      <email>String value</email>
      <groups>
        <groups>String value</groups>
        <groups>Another string value</groups>
      </groups>
      <siteMaps>
        <siteMaps>15</siteMaps>
        <siteMaps>25</siteMaps>
      </siteMaps>
      <timezone>String value</timezone>
      <virtualElements>
        <virtualElements>15</virtualElements>
        <virtualElements>25</virtualElements>
      </virtualElements>
    </vdFullDetailsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v2/op/vd.json

    {
      "vdFullDetailsDTO" : {
        "accessPoints" : {
          "accessPoints" : [ 15, 25 ]
        },
        "description" : "String value",
        "devices" : {
          "devices" : [ 15, 25 ]
        },
        "domainFQN" : "String value",
        "dynamicGroups" : {
          "dynamicGroups" : [ "String value", "Another string value" ]
        },
        "email" : "String value",
        "groups" : {
          "groups" : [ "String value", "Another string value" ]
        },
        "siteMaps" : {
          "siteMaps" : [ 15, 25 ]
        },
        "timezone" : "String value",
        "virtualElements" : {
          "virtualElements" : [ 15, 25 ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v2/op/vd

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v2/op">
      <vdopResultDTO>
        <warning>String value</warning>
      </vdopResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/vd.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
        "vdopResultDTO" : [ {
          "warning" : "String value"
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | POST

## Resource URL

/webacs/api/v3/op/vd

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
accessPoints Long[] | IDs of access points associated with the virtual domain. Optional.
description String | Description of the virtual domain. Optional.
devices Long[] | IDs of devices associated with the virtual domain. Optional.
domainFQN String | Required Fully qualified name of the virtual domain
dynamicGroups String[] | FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional.
email String | Email address for sending alarms notifications. Optional.
groups String[] | FQNs of groups associated with the virtual domain. Optional.
siteMaps Long[] | IDs of site maps associated with the virtual domain. Optional.
timezone String | Time zone of the virtual domain. Optional.
virtualElements Long[] | IDs of virtual elements associated with the virtual domain. Optional.

## Response Parameters

Attribute | Description
--- | ---
warning String | An error message in case if any error occurred

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v3/op/vd

    <?xml version="1.0" ?>
    <vdFullDetailsDTO>
      <accessPoints>
        <accessPoints>15</accessPoints>
        <accessPoints>25</accessPoints>
      </accessPoints>
      <description>String value</description>
      <devices>
        <devices>15</devices>
        <devices>25</devices>
      </devices>
      <domainFQN>String value</domainFQN>
      <dynamicGroups>
        <dynamicGroups>String value</dynamicGroups>
        <dynamicGroups>Another string value</dynamicGroups>
      </dynamicGroups>
      <email>String value</email>
      <groups>
        <groups>String value</groups>
        <groups>Another string value</groups>
      </groups>
      <siteMaps>
        <siteMaps>15</siteMaps>
        <siteMaps>25</siteMaps>
      </siteMaps>
      <timezone>String value</timezone>
      <virtualElements>
        <virtualElements>15</virtualElements>
        <virtualElements>25</virtualElements>
      </virtualElements>
    </vdFullDetailsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v3/op/vd.json

    {
      "vdFullDetailsDTO" : {
        "accessPoints" : {
          "accessPoints" : [ 15, 25 ]
        },
        "description" : "String value",
        "devices" : {
          "devices" : [ 15, 25 ]
        },
        "domainFQN" : "String value",
        "dynamicGroups" : {
          "dynamicGroups" : [ "String value", "Another string value" ]
        },
        "email" : "String value",
        "groups" : {
          "groups" : [ "String value", "Another string value" ]
        },
        "siteMaps" : {
          "siteMaps" : [ 15, 25 ]
        },
        "timezone" : "String value",
        "virtualElements" : {
          "virtualElements" : [ 15, 25 ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v3/op/vd

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v3/op">
      <vdopResultDTO>
        <warning>String value</warning>
      </vdopResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v3/op/vd.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/op",
        "vdopResultDTO" : [ {
          "warning" : "String value"
        } ]
      }
    }

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | POST

## Resource URL

/webacs/api/v4/op/vd

Unmodified

This resource has not been modified since the previous API version.

## Request Payload Parameters

Attribute | Description
--- | ---
accessPoints Long[] | IDs of access points associated with the virtual domain. Optional.
description String | Description of the virtual domain. Optional.
devices Long[] | IDs of devices associated with the virtual domain. Optional.
domainFQN String | Required Fully qualified name of the virtual domain
dynamicGroups String[] | FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional.
email String | Email address for sending alarms notifications. Optional.
groups String[] | FQNs of groups associated with the virtual domain. Optional.
siteMaps Long[] | IDs of site maps associated with the virtual domain. Optional.
timezone String | Time zone of the virtual domain. Optional.
virtualElements Long[] | IDs of virtual elements associated with the virtual domain. Optional.

## Response Parameters

Attribute | Description
--- | ---
warning String | An error message in case if any error occurred

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://10.64.88.203/webacs/api/v4/op/vd

    <?xml version="1.0" ?>
    <vdFullDetailsDTO>
      <accessPoints>
        <accessPoints>15</accessPoints>
        <accessPoints>25</accessPoints>
      </accessPoints>
      <description>String value</description>
      <devices>
        <devices>15</devices>
        <devices>25</devices>
      </devices>
      <domainFQN>String value</domainFQN>
      <dynamicGroups>
        <dynamicGroups>String value</dynamicGroups>
        <dynamicGroups>Another string value</dynamicGroups>
      </dynamicGroups>
      <email>String value</email>
      <groups>
        <groups>String value</groups>
        <groups>Another string value</groups>
      </groups>
      <siteMaps>
        <siteMaps>15</siteMaps>
        <siteMaps>25</siteMaps>
      </siteMaps>
      <timezone>String value</timezone>
      <virtualElements>
        <virtualElements>15</virtualElements>
        <virtualElements>25</virtualElements>
      </virtualElements>
    </vdFullDetailsDTO>

### Sample JSON Request Payload

https://10.64.88.203/webacs/api/v4/op/vd.json

    {
      "vdFullDetailsDTO" : {
        "accessPoints" : {
          "accessPoints" : [ 15, 25 ]
        },
        "description" : "String value",
        "devices" : {
          "devices" : [ 15, 25 ]
        },
        "domainFQN" : "String value",
        "dynamicGroups" : {
          "dynamicGroups" : [ "String value", "Another string value" ]
        },
        "email" : "String value",
        "groups" : {
          "groups" : [ "String value", "Another string value" ]
        },
        "siteMaps" : {
          "siteMaps" : [ 15, 25 ]
        },
        "timezone" : "String value",
        "virtualElements" : {
          "virtualElements" : [ 15, 25 ]
        }
      }
    }

### Sample XML Response Payload

https://10.64.88.203/webacs/api/v4/op/vd

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/webacs/api/v4/op">
      <vdopResultDTO>
        <warning>String value</warning>
      </vdopResultDTO>
    </mgmtResponse>

### Sample JSON Response Payload

https://10.64.88.203/webacs/api/v4/op/vd.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "vdopResultDTO" : [ {
          "warning" : "String value"
        } ]
      }
    }