Fetches the basic details of interfaces and REST URL links to their children and metrics
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 unavailable for this API version
This resource was introduced in API version 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
|
|
Resource URL
/webacs/api/v2/op/statisticsService/interfaces
Request Parameters
device
String
|
query
|
RequiredThe IP address or name of the device to which the interface belongs.
|
ifName
String
|
query
|
OptionalThe interface name whose details need to be fetched.
|
firstResult
Integer
|
query
|
OptionalDefines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
OptionalDefines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalComma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
String
|
|
|
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/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/interfaces?device=192.168.0.1&amp;ifName=GigabitEthernet0/1
" rootUrl="https://localhost/webacs/api/v2/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/interfaces.json?device=192.168.0.1&ifName=GigabitEthernet0/1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "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/statisticsService/interfaces
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
RequiredThe IP address or name of the device to which the interface belongs.
|
ifName
String
|
query
|
OptionalThe interface name whose details need to be fetched.
|
firstResult
Integer
|
query
|
OptionalDefines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
OptionalDefines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalComma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
String
|
|
|
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/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/statisticsService/interfaces?device=192.168.0.1&amp;ifName=GigabitEthernet0/1
" rootUrl="https://localhost/webacs/api/v3/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
<resources>
<childrenLink>Another string value</childrenLink>
<description>Another string value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>Another string value</metricsLink>
<name>Another string value</name>
<type>Another string value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/statisticsService/interfaces.json?device=192.168.0.1&ifName=GigabitEthernet0/1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
}, {
"childrenLink" : "Another string value",
"description" : "Another string value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "Another string value",
"name" : "Another string value",
"type" : "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/statisticsService/interfaces
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
RequiredThe IP address or name of the device to which the interface belongs.
|
ifName
String
|
query
|
OptionalThe interface name whose details need to be fetched.
|
firstResult
Integer
|
query
|
OptionalDefines the offset from the first result you want to fetch. Default is 0.
|
maxResults
Integer
|
query
|
OptionalDefines maximum amount of hits to be returned. Default is 20.
|
sort
String
|
query
|
OptionalComma-separated list of attribute names with their respective order.
|
Response Parameters
resources
ResourceDetailsDTO[]
|
|
childrenLink
String
|
|
description
String
|
|
details
String
|
Resource details (key-value pairs)
|
metricsLink
String
|
URL to fetch various metrics of a resource
|
name
String
|
|
type
String
|
|
|
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/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/statisticsService/interfaces?device=192.168.0.1&amp;ifName=GigabitEthernet0/1
" rootUrl="https://localhost/webacs/api/v4/op">
<resourcesDTO>
<resources>
<resources>
<childrenLink>String value</childrenLink>
<description>String value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>String value</metricsLink>
<name>String value</name>
<type>String value</type>
</resources>
<resources>
<childrenLink>Another string value</childrenLink>
<description>Another string value</description>
<details>
<item key="Another string value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
</item>
<item key="String value">
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</item>
</details>
<metricsLink>Another string value</metricsLink>
<name>Another string value</name>
<type>Another string value</type>
</resources>
</resources>
</resourcesDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/statisticsService/interfaces.json?device=192.168.0.1&ifName=GigabitEthernet0/1
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/statisticsService/interfaces?device=192.168.0.1&ifName=GigabitEthernet0/1\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"resourcesDTO" : [ {
"resources" : {
"resources" : [ {
"childrenLink" : "String value",
"description" : "String value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "String value",
"name" : "String value",
"type" : "String value"
}, {
"childrenLink" : "Another string value",
"description" : "Another string value",
"details" : [ {
"@key" : "Another string value",
"value" : "Another string value"
}, {
"@key" : "String value",
"value" : "String value"
} ],
"metricsLink" : "Another string value",
"name" : "Another string value",
"type" : "Another string value"
} ]
}
} ]
}
}