Environment Object

Defines the schema for configuring an Environment

Environment Object

API Endpointhttps://api.bigpanda.io/resources/v2.0/environments
Supported MethodsPOST, GET, PATCH, DELETE

Parameters

The Environments object schema includes the following attributes:

AttributeDescriptionType
nameUser-defined name for the environment.String
idSystem-generated unique identifier for an environment.String
environment_group_idSystem-generated id of the environment group.String
descriptionUser-defined description of the environment.String
rolesThe full access roles associated with the environment.String
read_only_rolesRead only roles that can view the environment.String
created_atUnix epoch time when the environment was created (in seconds).Long
created_byThe ID of the user who created the environment.String
updated_atUnix epoch time when the environment was last updated (in seconds).Long
updated_byThe ID of the user who last updated the environment.String
filterBPQL Filter to set conditions for the environment.String

Sample 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]"
}