API Endpoint
{{apiUrl}}/api/v1/properties/environment/{{environmentIdentifier}}
Headers
To authenticate the API request, you need to provide the Vansah Connect Token that is generated from the Jira workspace's Vansah configuration page.
Authorization | {{vansahConnectToken}}
|
Request Path Parameter
environmentIdentifier (String, Required): The unique identifier (GUID) of the environment to be updated
Request Body Parameters
name (String, Required): The name of the environment (e.g., "UAT").
project (Object, Required): Contains project-related details.
key (String, Required): Workspace project key (e.g., "DEMO").
Example Request Body
{
"name": "UAT", //Required: Name of the environment, e.g, UAT
"project" :{
"key":"DEMO", // Required: Workspace Project Key is required when using vansah connect API token
}
}
Response Body Parameters
success (Boolean, Required): Indicates whether the request was successful (
trueorfalse).message (String, Required): A message describing the result of the request (e.g., "Environment is updated successfully").
data (Object, Required): Contains the updated details of the environment.
name (String, Required): The name of the environment.
identifier (String, Required): The unique identifier for the environment.
Example Response Body
{
"success": true,
"message": "Environment is Updated successfully",
"data": {
"identifier": "f94d0e7d-1edb-11ed-bdf2-ae827922bf87",
"name": "UAT"
}
}