Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/topologyNetworkDetailsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/topologyNetworkDetailsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object topologyNetworkDetailsRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/topologyNetworkDetailsRead"
    }
}

Nested Schema : topologyNetworkDetailsRead

Type: object

Show Source

• Alias: string
  Alias

  Example: oracle.doceng.json.BetterJsonNull@7150439c
• Description: string
  Description about the name

  Example: cali5aca7483512
• DevId: integer
  Device ID

  Example: 9
• Index: integer
  Index

  Example: 40
• IntOper: string
  Operator

  Example: Up
• IntOperIcon: string
  Operator Icon

  Example: fa fa-circle green
• IPAddress: string
  IP Address

  Example: 127.0.0.1
• IPv6Address: string
  IPv6Address

  Example: ::1
• MACAddress: string
  MAC Address

  Example: EE:EE:EE:EE:EE:EE
• Name: string
  Interface Name

  Example: cali5aca7483512
• Speed: integer
  Speed

  Example: 1.0E10
• TrunkAdmin: string
  Trunk Admin

  Example: N/A
• TrunkAdminIcon: string
  Trunk Admin Icon

  Example: fa fa-circle gray
• TrunkOperIcon: string
  Trunk Oper Icon

  Example: fa fa-circle gray
• TrunkOperStatus: string
  Trunk Oper Status

  Example: N/A
• Type: string
  Network type

  Example: ethernetCsmacd

{
    "properties":{
        "Index":{
            "description":"Index",
            "type":"integer",
            "example":40
        },
        "Speed":{
            "description":"Speed",
            "type":"integer",
            "example":1.0E10
        },
        "Name":{
            "description":"Interface Name",
            "type":"string",
            "example":"cali5aca7483512"
        },
        "Description":{
            "description":"Description about the name",
            "type":"string",
            "example":"cali5aca7483512"
        },
        "Alias":{
            "description":"Alias",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "MACAddress":{
            "description":"MAC Address",
            "type":"string",
            "example":"EE:EE:EE:EE:EE:EE"
        },
        "Type":{
            "description":"Network type",
            "type":"string",
            "example":"ethernetCsmacd"
        },
        "DevId":{
            "description":"Device ID",
            "type":"integer",
            "example":9
        },
        "IPAddress":{
            "description":"IP Address",
            "type":"string",
            "example":"127.0.0.1"
        },
        "IPv6Address":{
            "description":"IPv6Address",
            "type":"string",
            "example":"::1"
        },
        "IntOper":{
            "description":"Operator",
            "type":"string",
            "example":"Up"
        },
        "IntOperIcon":{
            "description":"Operator Icon",
            "type":"string",
            "example":"fa fa-circle green"
        },
        "TrunkAdmin":{
            "description":"Trunk Admin",
            "type":"string",
            "example":"N/A"
        },
        "TrunkAdminIcon":{
            "description":"Trunk Admin Icon",
            "type":"string",
            "example":"fa fa-circle gray"
        },
        "TrunkOperStatus":{
            "description":"Trunk Oper Status",
            "type":"string",
            "example":"N/A"
        },
        "TrunkOperIcon":{
            "description":"Trunk Oper Icon",
            "type":"string",
            "example":"fa fa-circle gray"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top