Environment

Update environment

Update an existing environment. Note - when you use the update environment endpoint to update environment variables, you completely replace any existing variables.

patch/environments/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/environments/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

Environment ID

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

idstring

Environment ID

previewboolean

True if a short-lived ephemeral environment

created_timeinteger

Time environment created

created_by_idstring

ID of user who created environment

last_updated_timeinteger

Time environment last updated

last_updated_by_idstring

ID of user who last updated environment

organization_idstring

ID of organization (now workspace) associated with environment

workspace_idstring

ID of workspace associated with environment

namestring

Environment display name

descriptionstring

Environment description

encrypted_variablesstring

Serialized and encrypted environment variables

variablesobject

Environment variables

link_agent_labelstring

DEPRECATED - use link_agent_labels

link_agent_labelsstring[]

If specified, and if use_link_agent is true, test traffic will be routed through Link agents with any of these labels

use_link_agentboolean

If true, uses a Link Agent with specified link_agent_label for this environment

link_bypass_mabl_proxyboolean

If true, and if use_link_agent is true, test traffic will be routed directly via the Link Agent, bypassing the mabl HTTP proxy

use_source_control_tagboolean

If true, enables use of source_control_tag_target

source_control_tag_targetstring

All tests run in this environment will use this source control tag

page_load_wait'FAST' | 'NORMAL' | 'SLOW' | 'SLOWER'

Time to wait after page loads, if supported by the runtime.

Response

Environment updated

idstring

Environment ID

previewboolean

True if a short-lived ephemeral environment

created_timeinteger

Time environment created

created_by_idstring

ID of user who created environment

last_updated_timeinteger

Time environment last updated

last_updated_by_idstring

ID of user who last updated environment

organization_idstring

ID of organization (now workspace) associated with environment

workspace_idstring

ID of workspace associated with environment

namestring

Environment display name

descriptionstring

Environment description

encrypted_variablesstring

Serialized and encrypted environment variables

variablesobject

Environment variables

link_agent_labelstring

DEPRECATED - use link_agent_labels

link_agent_labelsstring[]

If specified, and if use_link_agent is true, test traffic will be routed through Link agents with any of these labels

use_link_agentboolean

If true, uses a Link Agent with specified link_agent_label for this environment

link_bypass_mabl_proxyboolean

If true, and if use_link_agent is true, test traffic will be routed directly via the Link Agent, bypassing the mabl HTTP proxy

use_source_control_tagboolean

If true, enables use of source_control_tag_target

source_control_tag_targetstring

All tests run in this environment will use this source control tag

page_load_wait'FAST' | 'NORMAL' | 'SLOW' | 'SLOWER'

Time to wait after page loads, if supported by the runtime.

Changes

No recorded changes to this operation across all 37 revisions of this API.