Incident Tag Management
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.
Available Routes
Example 1. Add an incident tag to an incident
curl --request POST \
--url https://api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags/:tag_id \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json' \
--data '{"tag_value" : "value_1"}'curl --request POST \
--url https://eu-api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags/:tag_id \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json' \
--data '{"tag_value" : "value_1"}'Example 2. Retrieve an incident tag from an incident
curl --request GET \
--url https://api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags/:tag_id \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json'curl --request GET \
--url https://eu-api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags/:tag_id \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json'Example 3. Remove an incident tag from an incident
curl --request DELETE \
--url https://api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags/:tag_id \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json'curl --request DELETE \
--url 'https://eu-api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags/:tag_id' \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json'Example 4. Add multiple tags to an incident
curl --request POST \
--url https://api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json' \
--data '[
{"tag_id": "some_tag_id_1", "tag_value": "value_1"},
{"tag_id": "some_tag_id_2", "tag_value": "value_2"}
]'curl --request POST \
--url https://eu-api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json' \
--data '[
{"tag_id": "some_tag_id_1", "tag_value": "value_1"},
{"tag_id": "some_tag_id_2", "tag_value": "value_2"}
]'Example 5. Retrieve all tags for an incident
curl --request GET \
--url https://api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags \
--header 'Authorization: Bearer <User API Key> \
--header 'Content-type: application/json'curl --request GET \
--url https://eu-api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags \
--header 'Authorization: Bearer <User API Key> \
--header 'Content-type: application/json'Example 6. Delete all tags from an incident
curl --request DELETE \
--url https://api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json'curl --request DELETE \
--url https://eu-api.bigpanda.io/resources/v2.0/environments/:env_id/incidents/:incident_id/tags \
--header 'Authorization: Bearer <User API Key>' \
--header 'Content-type: application/json'Incident Tag Parameters
Attribute | Description | Type |
|---|---|---|
incident_id | System-generated unique identifier for the incident that contains the incident tag. | String |
tag_id | System-generated unique identifier for the incident tag. | String |
tag_value | The content of the incident tag. | Tag Type |
Sample Object
{
"incident_id": "5e60feb92fb6844e00125d827a",
"tag_id": "itd-9ff554bc0c",
"tag_value": "P1"
}