Vertex REST Endpoints

Sort by

Task Path Method

Active Topology Automation/Vertex

REST APIs for Active Topology Automation, Vertex.

Create a New Vertex

Method: post

Path: /topology/v2/vertex

Create an Event

Method: post

Path: /topology/v2/vertex/event

Delete an existing Vertex

Method: delete

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

Delete an existing Vertex based on typeId and referenceId

Method: delete

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

Retrieve a list of Vertices

Method: post

Path: /topology/v2/vertex/eids

Retrieve a list of Vertices

Method: post

Path: /topology/v2/vertex/vertices

Retrieve Active Events based on device entityId

Method: get

Path: /topology/v2/vertex/device/eid/{entityId}/events

Retrieve All Vertices

Method: get

Path: /topology/v2/vertex

Retrieve an existing Vertex based on entityId

Method: get

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

Retrieve an existing Vertex based on entityId

Method: get

Path: /topology/v2/vertex/id/{id}

Retrieve an existing Vertex based on typeId and Id

Method: get

Path: /topology/v2/vertex/typeid/{typeid}/id/{id}

Retrieve an existing Vertex based on typeId and referenceId

Method: get

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

Retrieve Child Vertices based on entityId

Method: get

Path: /topology/v2/vertex/device/eid/{eid}/children

Retrieve Event Type values

Method: get

Path: /topology/v2/vertex/event/config/{type}

Retrieve Parent Vertices based on entityId

Method: get

Path: /topology/v2/vertex/device/eid/{eid}/parents

Retrieve the event based on entityId

Method: get

Path: /topology/v2/vertex/event/eid/{eid}

Retrieve Vertices within distance

Method: get

Path: /topology/v2/vertex/distant/eid/{eid}

Update an existing Event

Method: put

Path: /topology/v2/vertex/event

Update an existing Vertex

Method: put

Path: /topology/v2/vertex

Update the Active Event Max Severity for the device

Method: put

Path: /topology/v2/vertex/activeEvent/eid/{eid}/severity/{severity}