Edge REST Endpoints

Sort by

Task Path Method

Active Topology Automation/Edge

REST APIs for Active Topology Automation, Edge.

Create a new Edge

Method: post

Path: /topology/v2/edge

Delete an existing edge based on the entityId

Method: delete

Path: /topology/v2/edge/eid/{eid}

Delete an existing edge based on the fromNode and the toNode

Method: delete

Path: /topology/v2/edge/fromnode/{fromnode}/tonode/{tonode}

Delete an existing edge based on typeId and referenceId

Method: delete

Path: /topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}

Retrieve a list of communication edges

Method: get

Path: /topology/v2/edge/communication

Retrieve a list of communication edges in a network

Method: get

Path: /topology/v2/edge/communication/network/{network}

Retrieve a list of communication edges terminated on a location

Method: get

Path: /topology/v2/edge/communication/location/eid/{loceid}

Retrieve a list of communication edges terminated on a network entity code

Method: get

Path: /topology/v2/edge/communication/nec/eid/{neceid}

Retrieve a list of communication edges within a specific distance of a device

Method: get

Path: /topology/v2/edge/communication/center-vertex/eid/{eid}

Retrieve a list of communication edges, nodes and alarms in a network

Method: get

Path: /topology/v2/edge/network/{network}

Retrieve a list of containment edges

Method: get

Path: /topology/v2/edge/containment

Retrieve a list of edges

Method: get

Path: /topology/v2/edge

Retrieve a list of Edges

Method: post

Path: /topology/v2/edge/edges

Retrieve a list of edges using a list of entity ids

Method: post

Path: /topology/v2/edge/eids

Retrieve an existing Edge based on enityId

Method: get

Path: /topology/v2/edge/eid/{eid}

Retrieve an existing Edge based on typeId and referenceId

Method: get

Path: /topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}

Retrieve an related device edges based on the device enityId and edge label

Method: get

Path: /topology/v2/edge/device/eid/{eid}

Retrieve the location hierarchy down

Method: get

Path: /topology/v2/edge/vertex/eid/{eid}/hierarchy

Update an existing Edge

Method: put

Path: /topology/v2/edge

Update cost of existing edge

Method: patch

Path: /topology/v2/edge/eid/{eid}

Update cost of existing edge

Method: patch

Path: /topology/v2/edge/typeid/{typeid}/referenceid/{referenceid}