Skip to main content

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.

Learn more in the Real-Time Topology Mesh documentation.

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.

Example 1. Create topology
curl --request POST \
     --url https://api.bigpanda.io/resources/v2.0/topologies \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
     --data '{
      "links":[
         {
            "source":"host",
            "target":"check"
         },
         {
            "source":"host",
            "target":"cluster"
         }
      ]
}'
curl --request POST \
     --url https://eu-api.bigpanda.io/resources/v2.0/topologies \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
     --data '{
      "links":[
         {
            "source":"host",
            "target":"check"
         },
         {
            "source":"host",
            "target":"cluster"
         }
      ]
}'


Example 2. Retrieve a topology
curl --request GET \
     --url https://api.bigpanda.io/resources/v2.0/topologies/{id} \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.0/topologies/{id} \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \


Example 3. Retrieve all topologies
curl --request GET \
     --url https://api.bigpanda.io/resources/v2.0/topologies \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
curl --request GET \
     --url https://eu-api.bigpanda.io/resources/v2.0/topologies \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \


Example 4. Update a topology
curl --request PUT \
     --url https://api.bigpanda.io/resources/v2.0/topologies/590b72b91f0000130063753c \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
     --data '{
      "links":[
         {
            "source":"host",
            "target":"check"
         }
      ]
}'
curl --request PUT \
     --url https://eu-api.bigpanda.io/resources/v2.0/topologies/590b72b91f0000130063753c \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Bearer <User API Key>' \
     --data '{
      "links":[
         {
            "source":"host",
            "target":"check"
         }
      ]
}'


Example 5. Delete a topology
curl --request DELETE \
     --url https://api.bigpanda.io/resources/v2.0/topologies/1hjh4j234jh34 \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'Authorization: Bearer <User API Key>'
curl --request DELETE \
     --url https://eu-api.bigpanda.io/resources/v2.0/topologies/1hjh4j234jh34 \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'Authorization: Bearer <User API Key>'


In this section: