Home / Resources / API Reference

Environment

Base route: /api/environment

Update environment

This API endpoint updates the properties of an existing environment, such as its name, display order, or color identification.

Request

Parameters
environmentId
string
required
The unique identifier of the environment that needs to be updated.
name
string
required
The updated display name for the environment.
sortOrder
number
optional
The updated numeric value to define the position of the environment in the UI.
color
string
optional
The updated hex color code or name for visual categorization.
Request body

PUT /api/environment {   "environmentId": "string",   "name": "string",   "sortOrder": 0,   "color": "string" }

Response

200 OK