Get Network Details by Name
get
/api/topology/NetworkDetails
Gets a list of all network details and their attributes. You can use query parameters to customize the request.
Request
Query Parameters
-
DetailName(required): string
The name of the network detail to get. Allowed values are DeviceInfo, Interfaces, IPRoutes, ARPTable, MACAddresses, VLANs, CDPNeighbors, and Neighbors.Example:
Interfaces
-
DeviceName(required): string
The device name.Example:
router.example.com
-
DeviceZoneName(required): string
The device zone name.Example:
Default First Zone
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : topologyNetworkDetailsRead
Type:
Show Source
object
-
Alias: string
AliasExample:
oracle.doceng.json.BetterJsonNull@7150439c
-
Description: string
Description about the nameExample:
cali5aca7483512
-
DevId: integer
Device IDExample:
9
-
Index: integer
IndexExample:
40
-
IntOper: string
OperatorExample:
Up
-
IntOperIcon: string
Operator IconExample:
fa fa-circle green
-
IPAddress: string
IP AddressExample:
127.0.0.1
-
IPv6Address: string
IPv6AddressExample:
::1
-
MACAddress: string
MAC AddressExample:
EE:EE:EE:EE:EE:EE
-
Name: string
Interface NameExample:
cali5aca7483512
-
Speed: integer
SpeedExample:
1.0E10
-
TrunkAdmin: string
Trunk AdminExample:
N/A
-
TrunkAdminIcon: string
Trunk Admin IconExample:
fa fa-circle gray
-
TrunkOperIcon: string
Trunk Oper IconExample:
fa fa-circle gray
-
TrunkOperStatus: string
Trunk Oper StatusExample:
N/A
-
Type: string
Network typeExample:
ethernetCsmacd
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object