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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
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 Parameters
parentDomainName
String
|
query
|
OptionalAn optional parameter that can be used to specify fully qualified name of the parent domain
|
Response Parameters
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://localhost/webacs/api/v1/op/vd
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/vd" rootUrl="https://localhost/webacs/api/v1/op">
<vdDetailsDTO>
<description>String value</description>
<domainFQN>String value</domainFQN>
<email>String value</email>
<name>String value</name>
<timezone>String value</timezone>
</vdDetailsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/vd.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/vd",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"vdDetailsDTO" : {
"description" : "String value",
"domainFQN" : "String value",
"email" : "String value",
"name" : "String value",
"timezone" : "String value"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/vd
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
parentDomainName
String
|
query
|
OptionalAn optional parameter that can be used to specify fully qualified name of the parent domain
|
Response Parameters
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://localhost/webacs/api/v2/op/vd
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/vd" rootUrl="https://localhost/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>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/vd.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/vd",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"vdDetailsDTO" : [ {
"description" : "String value",
"domainFQN" : "String value",
"email" : "String value",
"name" : "String value",
"timezone" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/vd
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
parentDomainName
String
|
query
|
OptionalAn optional parameter that can be used to specify fully qualified name of the parent domain
|
Response Parameters
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://localhost/webacs/api/v3/op/vd
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/vd" rootUrl="https://localhost/webacs/api/v3/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://localhost/webacs/api/v3/op/vd.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/vd",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/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"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/vd
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
parentDomainName
String
|
query
|
OptionalAn optional parameter that can be used to specify fully qualified name of the parent domain
|
Response Parameters
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://localhost/webacs/api/v4/op/vd
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/vd" rootUrl="https://localhost/webacs/api/v4/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://localhost/webacs/api/v4/op/vd.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/vd",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/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"
} ]
}
}