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

GET vd

Returns the list of virtual domains. The parentDomainName request parameter can be used to return all subdomains of a particular domain.

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/vd

Unmodified

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

Request Parameters

Attribute Source Description

parentDomainName String

query

Optional

An optional parameter that can be used to specify fully qualified name of the parent domain

Response Parameters

Attribute Description

description String

Description of the virtual domain

domainFQN String

Fully qualified name of the virtual domain

email String

Email address for sending alarms notifications

name String

Name of the virtual domain

timezone String

Time zone of the virtual domain

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 Response Payload

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

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/op">
  <vdDetailsDTO>
    <description>String value</description>
    <domainFQN>String value</domainFQN>
    <email>String value</email>
    <name>String value</name>
    <timezone>String value</timezone>
  </vdDetailsDTO>
  <vdDetailsDTO>
    <description>Another string value</description>
    <domainFQN>Another string value</domainFQN>
    <email>Another string value</email>
    <name>Another string value</name>
    <timezone>Another string value</timezone>
  </vdDetailsDTO>
</mgmtResponse>

Sample JSON Response Payload

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

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://172.20.127.108/webacs/api/v2/op",
    "vdDetailsDTO" : [ {
      "description" : "String value",
      "domainFQN" : "String value",
      "email" : "String value",
      "name" : "String value",
      "timezone" : "String value"
    }, {
      "description" : "Another string value",
      "domainFQN" : "Another string value",
      "email" : "Another string value",
      "name" : "Another string value",
      "timezone" : "Another string value"
    } ]
  }
}