Create environment

POST

/api/v1/environments/

curl --request POST \
  --url https://example.com/api/v1/environments/ \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "protected": false, "platform": "databricks", "gitProvider": "example", "gitRepository": "example", "targetGitBranch": "example", "secretScope": "example", "databricksClientIdKey": "example", "databricksClientSecretKey": "example", "configuration": {}, "isActive": true, "createdBy": "example" }'

Create a new deployment environment

Request Body^required

Media typeapplication/json

EnvironmentCreateRequest

Request to create a new environment.

object

name

required

Name

Unique name for the environment

string

description

Any of:

string

string

null

null

protected

Protected

If true, UI editing is disabled for this env

boolean

platform

Any of:

string

string

null

null

gitProvider

Any of:

string

string

null

null

gitRepository

Any of:

string

string

null

null

targetGitBranch

Any of:

string

string

null

null

secretScope

Any of:

string

string

null

null

databricksClientIdKey

Any of:

string

string

null

null

databricksClientSecretKey

Any of:

string

string

null

null

configuration

Configuration

Key-value configuration for the environment (e.g., Databricks, Snowflake credentials)

object

key

additional properties

any

isActive

Any of:

boolean

boolean

null

null

createdBy

Any of:

string

string

null

null

Responses

201

Successful Response

Media typeapplication/json

EnvironmentResponse

Environment response model.

object

id

required

Id

string

name

required

Name

string

description

required

Any of:

string

string

null

null

protected

required

Protected

boolean

platform

required

Platform

string

gitProvider

Any of:

string

string

null

null

gitRepository

Any of:

string

string

null

null

targetGitBranch

Any of:

string

string

null

null

secretScope

Any of:

string

string

null

null

databricksClientIdKey

Any of:

string

string

null

null

databricksClientSecretKey

Any of:

string

string

null

null

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

createdBy

Any of:

string

string

null

null

updatedBy

Any of:

string

string

null

null

Example^generated

{
  "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"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}