Skip to main content

Environments

Use the Environments API to define incident groups based on incident properties such as source, severity, or alert data.

Environments group related incidents together in a filtered incident list view, allowing your team to focus on the incidents relevant to their role.

Environments

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.

Use Cases

Define custom Environments that help your users focus on the most relevant information to them. Common use cases include Environments that are based on areas of responsibility within IT and DevOps teams, processes, or escalation paths. For example, you can define an Environment for:

  • A DBA team that focuses on incidents related to production databases.

  • An engineering team that is responsible for incidents related to a particular set of applications.

  • Level-1 or NOC operators that work only on high-severity incidents.

  • The emergency contacts of a customer-facing service. Include only critical alerts from the service, and then set up an AutoShare to immediately notify the emergency contacts.

Creating environments via API

The basic environment builder in the BigPanda UI guides users through the creation of environments without the need for a BPQL filter. However, once an environment has been created or edited using the Environments API, the basic environment builder will no longer be available for that environment.

Environments are configured using BigPanda Query Language (BPQL) to define rules on which incidents will be grouped together. The rules construct a simple and/or boolean expression that is evaluated against the incident properties.

Parameters

The Environments object schema includes the following attributes:

Attribute

Description

Type

name

User-defined name for the environment.

String

id

System-generated unique identifier for an environment.

String

environment_group_id

System-generated id of the environment group.

String

description

User-defined description of the environment.

String

roles

The full access roles associated with the environment.

String

read_only_roles

Read only roles that can view the environment.

String

created_at

Unix epoch time when the environment was created (in seconds).

Long

created_by

The ID of the user who created the environment.

String

updated_at

Unix epoch time when the environment was last updated (in seconds).

Long

updated_by

The ID of the user who last updated the environment.

String

filter

BPQL Filter to set conditions for the environment.

String

Sample Environments Object

{
  "name": "Production Crits",
  "id": "60b796b886d4050040dc9192",
  "environment_group_id": "63bdaabcd395ll21200c3dd55",
  "roles": [            
      {                
          "id": "643d421d0961d74e3c879f13",                
          "name": "Operator"            
      }        
  ],
  "read_only_roles": [            
      {                
          "id": "921d421d0837r74e3c879g82",                
          "name": "Read Only"            
      }        
  ],
  "description": "NOC Team",
  "created_at": 1622644409,
  "updated_at": 1622644409,
  "updated_by": "608ffeefcc86eff26b51412a",
  "created_by": "608ffeefcc86eff26b51412a",
  "filter": "incident_tag.priority=P1 AND source IN [nagios]"
}
In this section: