Skip to main content
POST
/
api
/
projects
/
{projectId}
/
environments
Create environment
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "brms",
  "key": "<string>",
  "deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approvalMode": "none",
  "approvalGroups": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "brms",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiredReviewers": true,
  "addToWorkflow": true,
  "approvalGroups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "approvalMode": "require_one_per_team",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "accessToken": "<string>",
  "key": "<string>",
  "release": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "<string>",
    "createdAt": "<string>",
    "version": 123,
    "semanticVersion": "<string>"
  },
  "releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deployment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "provider": "<string>",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "configuration": {},
    "deletedAt": "<string>"
  },
  "project": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "key": "<string>"
  },
  "reviewers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "workflowOrder": 123,
  "changeRequests": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "status": "<string>",
      "createdAt": "<string>"
    }
  ],
  "deletedAt": "<string>",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
projectId
string<uuid>
required

ID of the project to create the environment in

Body

application/json
​
name
string
required

Name of the environment

​
type
enum<string>
required

Type of environment (brms or deployment)

Available options:
brms,
deployment
​
key
string | null

Unique key for BRMS type environments (required when type is brms)

​
deploymentId
string<uuid> | null

ID of the deployment configuration (required when type is deployment)

​
approvalMode
enum<string> | null
default:none

Approval mode for deployments to this environment

Available options:
require_one_per_team,
none_create_request,
require_any,
none,
​
approvalGroups
string<uuid>[]

List of group IDs that can approve deployments

Group ID

Response

200 - application/json

The created environment

The created environment

​
id
string<uuid>
required

Unique identifier of the environment

​
name
string
required

Name of the environment

​
type
enum<string>
required

Type of environment (brms or deployment)

Available options:
brms,
deployment
​
projectId
string<uuid>
required

ID of the project

​
requiredReviewers
boolean
required

Whether reviewers are required

​
addToWorkflow
boolean
required

Whether the environment is part of the deployment workflow

​
approvalGroups
object[]
required

Groups that can approve deployments

​
approvalMode
enum<string>
required

Approval mode for deployments to this environment

Available options:
require_one_per_team,
none_create_request,
require_any,
none
​
createdAt
string
required

Timestamp when the environment was created

​
updatedAt
string
required

Timestamp when the environment was last updated

​
accessToken
string | null

Access token for the environment

​
key
string | null

Unique key for BRMS type environments

​
release
object

Currently deployed release information

​
releaseId
string<uuid> | null

ID of the currently deployed release

​
deploymentId
string<uuid> | null

ID of the associated deployment

​
deployment
object

Deployment configuration for the environment

​
project
object

Project the environment belongs to

​
reviewers
object[]

List of members assigned as reviewers

​
workflowOrder
number | null

Order position in the deployment workflow

​
changeRequests
object[]

Pending change requests for this environment

​
deletedAt
string | null

Timestamp when the environment was deleted

​
metadata
object

Additional metadata from the deployment provider