Sign in
LinkLabelUsage

Update an environment's Link labels

Changed on

Replaces only the environment's link_agent_labels (deduplicated) and keeps the deprecated link_agent_label equal to the first label. No other environment field changes.

patch/environments/{environment_id}/link

Request

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

Path parameters

environment_idstring required

The ID of the environment

Headers

If-Matchstring

The version from the label usage or environment being updated. Functionally required: omitting it returns 428. Declared optional so a missing header reaches the service instead of failing schema validation with a generic 400.

Request body

link_agent_labelsstring[] required

The environment's new labels, replacing the current ones

Response

The environment's updated Link label usage

entity_type'environment' | 'database_connection'
idstring

Environment or database connection ID

workspace_idstring

Workspace ID

namestring

Environment or database connection name

use_link_agentboolean

Environments only - whether test traffic routes through Link

link_agent_labelsstring[]

Environment labels, or the database connection's default connection property labels. Absent when none are stored.

versionstring

The entity version, to send as If-Match when updating these labels

Changes