BigPanda Incidents API
Search, read, assign, comment, tag, snooze, merge, split and resolve correlated incidents.
Operations 21
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/resources/v2.0/environments/{environment_id}/incidents
List incidents in an environment · BigPanda List Incidents
#
Ask an LLM
“Which incidents are currently open in my BigPanda environment?”
“Can I list only active incidents for one environment?”
Tell an agent
List the incidents in environment {environment_id}.
Show incidents in environment {environment_id} with active set to {active}.
GET
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}
Get an incident's details · BigPanda Get Incident
#
Ask an LLM
“What are the details of a specific incident?”
“Can I pull the full record for one incident by its ID?”
Tell an agent
Get incident {incident_id} in environment {environment_id}.
Show me everything about incident {incident_id} from environment {environment_id}.
POST
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags
Set several tags on an incident at once · Add Multiple Incident Tags to an Incident
#
Ask an LLM
“Can I add or update several incident tags in one request?”
“How do I bulk-set tag values on a single incident?”
Tell an agent
Set multiple incident tags on incident {incident_id} in environment {environment_id}.
Bulk-update the tags on incident {incident_id} ({environment_id}) with these values.
DELETE
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags
Remove all tags from an incident · Delete All Tags for an Incident
#
Ask an LLM
“Can I clear every tag off an incident in one go?”
“How do I wipe all incident tag values from a single incident?”
Tell an agent destructive · confirm first
Delete all incident tags from incident {incident_id} in environment {environment_id}.
Clear every tag on incident {incident_id} in {environment_id}.
GET
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags
List all tags on an incident · Retrieve All Tags for an Incident
#
Ask an LLM
“Which incident tags have been set on this incident?”
“Can I see every tag value attached to one incident?”
Tell an agent
List all incident tags on incident {incident_id} in environment {environment_id}.
Show the tag values set on incident {incident_id} in {environment_id}.
POST
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags/{incidenttag_id}
Set a single tag value on an incident · Add an Incident Tag to an Incident
#
Ask an LLM
“Can I set one incident tag, like priority, on a specific incident?”
“Does setting an incident tag overwrite a value that's already there?”
Tell an agent
Set tag {incidenttag_id} to {tag_value} on incident {incident_id} in environment {environment_id}.
Update the {incidenttag_id} tag on incident {incident_id} ({environment_id}) to {tag_value}.
DELETE
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags/{incidenttag_id}
Remove one tag from an incident · Delete an Incident Tag from an Incident
#
Ask an LLM
“Can I remove a single tag value from an incident but keep the others?”
“How do I clear just one incident tag on an incident?”
Tell an agent destructive · confirm first
Delete tag {incidenttag_id} from incident {incident_id} in environment {environment_id}.
Clear only the {incidenttag_id} tag on incident {incident_id} ({environment_id}).
GET
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/tags/{incidenttag_id}
Get one tag's value on an incident · Retrieve an Incident Tag from an Incident
#
Ask an LLM
“What value does a particular tag have on this incident?”
“Can I read just one incident tag from an incident?”
Tell an agent
Get tag {incidenttag_id} on incident {incident_id} in environment {environment_id}.
Tell me the {incidenttag_id} value on incident {incident_id} ({environment_id}).
PUT
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/assignment
Assign an incident to a user · Assign Incident
#
Ask an LLM
“How do I assign an incident to someone on my team?”
“Can I make a specific user responsible for an incident through the API?”
Tell an agent
Assign incident {incident_id} in environment {environment_id} to {assignee}.
Make {assignee} the owner of incident {incident_id} ({environment_id}).
DELETE
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/assignment
Unassign an incident · Unassign Incident
#
Ask an LLM
“Can I remove the assignee from an incident?”
“How do I leave an incident with nobody assigned?”
Tell an agent destructive · confirm first
Unassign incident {incident_id} in environment {environment_id}.
Remove whoever is assigned to incident {incident_id} ({environment_id}).
POST
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/comments
Comment on an incident · Comment on Incident
#
Ask an LLM
“Can I post a note to an incident's timeline from a script?”
“How do I add a comment to a BigPanda incident?”
Tell an agent
Comment {comment} on incident {incident_id} in environment {environment_id}.
Add the note {comment} to incident {incident_id} ({environment_id}).
POST
/resources/v2.0/incidents/tags/definitions
Define a new incident tag · Create an Incident Tag Definition
#
Ask an LLM
“How do I define a new incident tag that users can fill in manually?”
“Can a new incident tag definition be enriched automatically?”
Tell an agent
Create an incident tag definition named {name} of type {type}.
Define incident tag {name} ({type}) described as {description}, with manual input set to {canManualInput}.
GET
/resources/v2.0/incidents/tags/definitions
List incident tag definitions · Get All Incident Tags Definitions
#
Ask an LLM
“What incident tags are defined for my organization?”
“Can I list only the active incident tag definitions of a given type?”
Tell an agent
List all incident tag definitions.
Show incident tag definitions of type {type} with active set to {active}.
GET
/resources/v2.0/incidents/{incident_id}/activities
List enrichment activity on an incident · Get Incident Activities
#
Ask an LLM
“What enrichment actions have been taken on this incident?”
“Can I filter an incident's activity log by activity type?”
Tell an agent
Get the activities for incident {incident_id}.
List {types} activities on incident {incident_id}, page {page} with {per_page} per page.
GET
/resources/v2.0/incidents/tags/definitions/{incidenttag_id}
Get an incident tag definition · Get an Incident Tag Definition
#
Ask an LLM
“How is a particular incident tag defined?”
“Can I look up one incident tag definition by its ID?”
Tell an agent
Get incident tag definition {incidenttag_id}.
Show the type and settings of the {incidenttag_id} tag definition.
PUT
/resources/v2.0/incidents/tags/definitions/{incidenttag_id}
Update an incident tag definition · Update an Incident Tag Definition
#
Ask an LLM
“Can I rename an incident tag definition or turn it off?”
“Can I change how an existing incident tag definition is enriched?”
Tell an agent
Update incident tag definition {incidenttag_id} to name {name} and type {type}.
Change the enrichment config of tag definition {incidenttag_id} to {enrichment_config}, keeping name {name} and type {type}.
POST
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/merge
Merge incidents into one · Merge Incidents
#
Ask an LLM
“How do I merge several related incidents into a single incident?”
“Is there a limit on how many alerts a merged incident can hold?”
Tell an agent
Merge incidents {source_incidents} into incident {incident_id} in environment {environment_id}.
Fold {source_incidents} into {incident_id} ({environment_id}) with the comment {comment}.
POST
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/resolve
Resolve an incident · Resolve Incident
#
Ask an LLM
“Can I resolve an incident from an automation once the fix is in?”
“What do I have to include when resolving an incident through the API?”
Tell an agent
Resolve incident {incident_id} in environment {environment_id} with comments {comments}.
Close out incident {incident_id} ({environment_id}) noting {comments}.
PUT
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/snooze
Snooze an incident until a set time · Snooze Incident
#
Ask an LLM
“Can I snooze a noisy incident until a specific time?”
“Can a snooze be cancelled automatically if the incident gets updated?”
Tell an agent
Snooze incident {incident_id} in environment {environment_id} until {end_time}.
Snooze {incident_id} ({environment_id}) until {end_time}, cancelling on updates set to {cancel_on_incident_updates}.
DELETE
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/snooze
Unsnooze an incident · Unsnooze Incident
#
Ask an LLM
“How do I wake up an incident I snoozed earlier?”
“Can I end a snooze before its end time?”
Tell an agent destructive · confirm first
Unsnooze incident {incident_id} in environment {environment_id}.
Remove the snooze from incident {incident_id} ({environment_id}) now.
POST
/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/split
Split alerts out into a new incident · Split Incident
#
Ask an LLM
“Can I move some alerts out of an incident into a new one?”
“How do I split an incident that correlated unrelated alerts?”
Tell an agent
Split alerts {alerts} from incident {incident_id} in environment {environment_id} into a new incident.
Pull alerts {alerts} out of {incident_id} ({environment_id}) into their own incident, commenting {comment}.
Documentation
📖
Documentation
https://api-docs.bigpanda.io/incidents
📖
APIReference
https://api-docs.bigpanda.io/incidents