Envs
Create a new environment or start run for existing environment
🔒 Requires the create:environment permission
The environment slug for creating or targeting existing environment
The blueprint/package name, e.g. @bluebricks/postgres
The package version e.g. 1.2.3
1.2.3Controls how the deployment is executed. autoApply automatically applies changes without manual approval; autoApprove skips approval and pending; validateOnly validates the deployment without executing; planOnly generates a plan without executing; driftDetection runs only configuration-drift detection; draft creates the deployment record without starting any activity. autoRemediation automatically remediates detected drifts; deployType can't be used together with deprecated flags.
autoApprovePossible values: Deprecated. Use deployType='autoApprove' instead
Deprecated. Use deployType='validateOnly' instead
falseDeprecated. Use deployType='planOnly' instead
falseEnable incremental mode to skip deployments with no changes
falseDeprecated. Use deployType='draft' instead
falseDeprecated. Use deployType='driftDetection' instead
falseEnable drift detection for the environment
falseTarget collection for environment
Created environment and task details or validation result
Created environment and task details or validation result
Failed to create environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:environment permission
Package not found or not enabled for organization
Environment slug already exists
Too many requests
Failed to create environment
Get an existing environment from a git repository
🔒 Requires the read:environment permission
Environment ID or slug
Environment retrieved successfully
Environment retrieved successfully
The environment's slug e.g. my-environment
Indicates whether the environment is set to automatically trigger deployments on git events
trueGit repository URL
https://github.com/org/repoPath to the subdirectory within the repository
/infra/prod/vpcBase git branch name that the environment listens to for events
mainName of the package
@bluebricks/vpcSlug of the collection
productionInfrastructure as Code tool type
terraformPossible values: Invalid request payload
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Environment not found
Too many requests
Create a new environment from a git repository with automatic deployment triggers on git events. This endpoint creates an environment that listens to push and pull request events where the base branch matches git_base_branch. Push events trigger install deployments. Pull request events always trigger plan-only tasks.
🔒 Requires the create:environment permission
Git repository URL
https://github.com/org/repoBase git branch name. Environment will trigger deployments on push events and pull requests targeting this branch.
mainPath to the subdirectory within the repository
/infra/prod/vpcThe environment's slug e.g. my-environment
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeInfrastructure as Code tool type
terraformPossible values: Name of the package
@bluebricks/vpcOptional description for the package
Environment creation started successfully
Environment creation started successfully
Event ID tracking the async publisher job. Only present when a new package needs to be hydrated.
Environment slug
Invalid request payload
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:environment permission
Collection not found
Resource already exists
Too many requests
Retrieve all deployment states for an environment
🔒 Requires the read:environment permission
Environment ID or slug
List of environment states with metadata
List of environment states with metadata
The unique identifier of the state
123e4567-e89b-12d3-a456-426614174000The unique identifier of the package
terraform_aws_secretsmanagerThe hierarchical path of the package in the deployment
root.terraform_aws_secretsmanagerThe current status of the deployment state. Returns "n/a" when metadata is not available
livePossible values: ID of the latest run that created/updated the state. Returns "n/a" when metadata is not available
run-abc123Whether the state is currently locked
falseWhen the state was first created. Returns "n/a" when metadata is not available
2025-10-10T12:34:56.123ZWhen the state was last updated
2025-10-12T08:20:00.456ZThe IaC type for this package
terraformPossible values: The package version associated with this state
1.0.0Bad request
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Environment not found
Too many requests
Return environments information by collection
🔒 Requires the read:environment permission
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eSpecifies the attribute by which the returned list should be sorted
timestampPossible values: Results offset to allow pagination e.g. 10
0Example: 10Specifies the order - ascending or descending - by which the returned list should be sorted e.g. ASC
Results limit to allow pagination, e.g. 50
20Example: 10Structure: [key1=value1,key2=value2&value3]
Enables searching within the list for environment names that match a particular query
Also includes archived environments
If true, return only environments with outdated package versions
Paginated information of filtered environments for a collection
Paginated information of filtered environments for a collection
Indicates if any outdated environments exist
Failed to get environments information
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Package not found
Too many requests
Archive multiple environments
🔒 Requires the update:environment permission
List of environment slugs, e.g. ["test-environment", "my-environment"]
["test-environment","my-environment"]Environment archived / unarchived successfully
Environment archived / unarchived successfully
The environment's slug e.g. my-environment
Updated archived status
Failed to archive / unarchive environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environments not found to be archived / unarchived
Too many requests
Unarchive multiple environments
🔒 Requires the update:environment permission
List of environment slugs, e.g. ["test-environment", "my-environment"]
["test-environment","my-environment"]Environment archived / unarchived successfully
Environment archived / unarchived successfully
The environment's slug e.g. my-environment
Updated archived status
Failed to archive / unarchive environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission. 🔒 Requires the update:environment permission
Environments not found to be archived / unarchived
Too many requests
Enable drift detection for multiple environments
🔒 Requires the update:environment permission
List of environment slugs, e.g. ["test-environment", "my-environment"]
["test-environment","my-environment"]Environment drift detection status updated successfully
Environment drift detection status updated successfully
The environment's slug e.g. my-environment
Updated drift detection status
Failed to update drift detection status
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environments not found to update drift detection status
Too many requests
Disable drift detection for multiple environments
🔒 Requires the update:environment permission
List of environment slugs, e.g. ["test-environment", "my-environment"]
["test-environment","my-environment"]Environment drift detection status updated successfully
Environment drift detection status updated successfully
The environment's slug e.g. my-environment
Updated drift detection status
Failed to update drift detection status
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission. 🔒 Requires the update:environment permission
Environments not found to update drift detection status
Too many requests
Upload state files to environment
🔒 Requires the create:environment permission
Environment ID or slug
JSON string containing array of state metadata with file references. Each item must have either package_id (for unique packages) or hierarchical_path (for packages that appear at multiple positions in the blueprint tree, e.g., bpA.bpB.mypackageid).
[{"package_id":"terraform_aws_secretsmanager","state_file":"state_1"},{"hierarchical_path":"sub_blueprint.terraform_aws_eks_auto","state_file":"state_2"}]Optional blueprint version to use for resolving the package tree. If not provided, the latest published version is used.
1.0.0State upload results
State upload results
Package identifier
terraform_aws_secretsmanagerFull hierarchical path of the package in the blueprint tree (e.g., root.bpA.bpB.mypackageid)
root.terraform_aws_secretsmanagerUpload status
successPossible values: Reason for failure (only present when status is failed)
Failed to upload state files
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:environment permission
Environment / Package not found
Too many requests
Last updated
Was this helpful?