Update environment
PATCH
/api/v1/environments/{environment_id}
const url = 'https://example.com/api/v1/environments/example';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"name":"example","description":"example","protected":true,"platform":"example","gitProvider":"example","gitRepository":"example","targetGitBranch":"example","secretScope":"example","databricksClientIdKey":"example","databricksClientSecretKey":"example","configuration":{},"isActive":true,"updatedBy":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/api/v1/environments/example \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "description": "example", "protected": true, "platform": "example", "gitProvider": "example", "gitRepository": "example", "targetGitBranch": "example", "secretScope": "example", "databricksClientIdKey": "example", "databricksClientSecretKey": "example", "configuration": {}, "isActive": true, "updatedBy": "example" }'Update an existing deployment environment
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”environment_id
required
Environment Id
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
EnvironmentUpdateRequest
Request to update an environment.
object
Examplegenerated
{ "name": "example", "description": "example", "protected": true, "platform": "example", "gitProvider": "example", "gitRepository": "example", "targetGitBranch": "example", "secretScope": "example", "databricksClientIdKey": "example", "databricksClientSecretKey": "example", "configuration": {}, "isActive": true, "updatedBy": "example"}Responses
Section titled “Responses”Successful Response
Media typeapplication/json
EnvironmentResponse
Environment response model.
object
id
required
Id
string
name
required
Name
string
protected
required
Protected
boolean
platform
required
Platform
string
configuration
required
Configuration
object
key
additional properties
any
isActive
required
Isactive
boolean
createdAt
required
Createdat
string format: date-time
updatedAt
required
Updatedat
string format: date-time
Examplegenerated
{ "id": "example", "name": "example", "description": "example", "protected": true, "platform": "example", "gitProvider": "example", "gitRepository": "example", "targetGitBranch": "example", "secretScope": "example", "databricksClientIdKey": "example", "databricksClientSecretKey": "example", "configuration": {}, "isActive": true, "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:00Z", "createdBy": "example", "updatedBy": "example"}Validation Error
Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}