v1

latestOpenAPI 3.1.02026-07-261344388.3 KB

Environment

Create environment

Creates a new environment within a project for deploying releases.

post/api/projects/{projectId}/environments

Path parameters

projectIdstring uuid required

ID of the project to create the environment in

Request body

namestring required

Name of the environment

keystring nullable

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

type'brms' | 'deployment' required

Type of environment (brms or deployment)

deploymentIdstring uuid nullable

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

approvalMode'require_one_per_team' | 'none_create_request' | 'require_any' | 'none' | 'null' nullable

Approval mode for deployments to this environment

approvalGroupsstring[]

List of group IDs that can approve deployments

Response

The created environment

idstring uuid required

Unique identifier of the environment

namestring required

Name of the environment

accessTokenstring nullable

Access token for the environment

type'brms' | 'deployment' required

Type of environment (brms or deployment)

keystring nullable

Unique key for BRMS type environments

releaseIdstring uuid nullable

ID of the currently deployed release

deploymentIdstring uuid nullable

ID of the associated deployment

projectIdstring uuid required

ID of the project

requiredReviewersboolean required

Whether reviewers are required

addToWorkflowboolean required

Whether the environment is part of the deployment workflow

workflowOrdernumber nullable

Order position in the deployment workflow

approvalMode'require_one_per_team' | 'none_create_request' | 'require_any' | 'none' required

Approval mode for deployments to this environment

createdAtstring required

Timestamp when the environment was created

updatedAtstring required

Timestamp when the environment was last updated

deletedAtstring nullable

Timestamp when the environment was deleted

metadataobject

Additional metadata from the deployment provider