Topology UI
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.
API rate limitations
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.
Topology UI
Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
BigPanda recommends adding Authentication headers only in the secure tool you use to make API calls.
Parameters
The Topology UI object schema includes the following attributes:
Attribute | Description | Type |
|---|---|---|
links | Links present in the topology model. Every item in the array is comprised of a link source and a link target, as follows: Attributes: - source - The source tag of the link in the topology model. - target - The target tag of the link in the topology model. | Array |
created_at | Unix epoch time when the topology model was created (in seconds). | Number |
created_by | The autogenerated ID of the user who created the topology model. | String |
updated_at | Unix epoch time when the topology model was last updated (in seconds). | Number |
updated_by | The autogenerated ID of the user who last updated the topology model. | String |
Sample Object
{
"links":[
{
"source":"host",
"target":"check"
},
{
"source":"host",
"target":"cluster"
}
]
}