The BigPanda Topology UI API allows users to manually structure the visual appearance of the topology between alert tag nodes, charting information that can be used to aid in investigating the root cause of the incident and assessing potential impact.
To learn more about how the Real-Time Topology Mesh feature works, see the Real-Time Topology Mesh feature guide.
To maintain quality of service, BigPanda APIs are limited to 5 requests per second.
Additional requests will return a 429 response code and the request will need to be retried.
Roles with the following permission can use the Topology UI API:
|Topology View||View, upload, or edit topology maps via API, and view the Topology section in incident details.|
Permission access levels can be adjusted by selecting either View or Full Access. To learn more about how BigPanda's permissions work, see the Roles Management guide.
Use the Topology UI API to perform these actions:
|Create Topology||Creates a new topology model (only one per organization).|
|Retrieve a Topology||Retrieves the organization’s topology model.|
|Retrieve All Topologies||Retrieves all of the organization’s topology models.|
|Update a Topology||Updates the organization's topology model.|
|Delete a Topology||Deletes the organization's topology model and removes it from the system.|