Skip to main content

Environments Updates

Configuring environments is now easier than ever with the new updates to the Environment configuration screen and Environments API. This update includes a modernized UI, full alignment between the Environments API and UI, and additional configuration options in the UI.

From the configuration screen, you can now create and view AutoShare rules, saving you time and effort. You can also create a description for environments so operators can understand their purpose at a glance.

New Configuration Screen

Sandboxes only

Updates to the configuration screen are currently available in sandbox organizations only.

The environment creation pane now has an updated, modernized look which includes a new configuration feature.

incidents_environmentspane_newcreator.png

Environment Description

The environment creation pane now includes a new, optional description field.

incidents_environmentspane_descriptionfield.png

The description will appear in the Environments pane when you hover over the environment name. You can use this to help your team members understand the purpose of an environment

incidents_environmentspane_descriptionhover.png

AutoShare Rules

Rather than navigating out of the Incidents tab, you can now configure AutoShare rules for an environment right within the environment creation pane.

To create a new rule, click Advanced Settings. In the AutoShare rules section, click the Create AutoShare button.

incidents_environmentspane_createautoshare.png

Advanced Settings

The Advanced Settings option only appears after you have initially created an environment.

This opens the AutoShare settings page where you can follow the steps to Create an AutoShare Rule. Once you have saved your configuration, the AutoShare rule(s) associated with the environment will appear in the Advanced Settings section.

incidents_environmentspane_autosharerules.png

Environments API Updates

The Environments API is now fully aligned with UI capabilities. You can now create, retrieve, update, and delete environment groups, update environment descriptions, and assign and retrieve roles for environments using the API.

New Attributes

The following new attributes are available for creating and updating environments:

Attribute

Description

Type

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.

Array of strings

read_only_roles

The read-only roles associated with the environment.

Array of strings

Sample Object

Create an Environment (POST) Sample Call

Update an Environment (PATCH) Sample Call

Environment Groups Object

Environment groups can now be created, retrieved, updated, and deleted via the API.

See the Environment Groups Object documentation for more information.

The following new endpoints are available:

Action

Definition

Description

Create an Environment Group 

POST 

/environments-groups

Creates an environment group.

Retrieve All Environment Groups 

GET 

/environments-groups 

Retrieves all environment groups.

Update Environment Group 

PUT 

/environments-groups/{id} 

Updates an environment group.

Delete Environment Group 

DELETE 

/environments-groups/{id} 

Deletes an environment group.