Environments
Describe Environment with associated cloud accounts
🔒 Requires the read:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeInformation about the environment
Failed to get environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Environment not found
Too many requests
Failed to get environment
Delete an environment from the organization
🔒 Requires the delete:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeUpdated information about the environment
Failed to delete the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:environment permission
Environment not found
Too many requests
Create an environment for deploying blueprints
🔒 Requires the create:environment permission
The environment name e.g. Production Europe
Production EuropeThe environment color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the environment is the default for the organization e.g. true
Information about created environment
Failed to create an environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:environment permission
Too many requests
Enable an environment
🔒 Requires the update:environment permission
Updated information about the environment
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment not found
Too many requests
Disable an environment
🔒 Requires the delete:environment permission
Updated information about the environment
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:environment permission
Environment not found
Too many requests
Change default environment for the organization
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeUpdated information about the environment
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment not found
Too many requests
Update environment properties such as color code, name, pre-release status, or associated users. Note: The slug remains unchanged even if the name is updated.
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe environment name e.g. Production Europe
Production EuropeThe environment color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the environment allows pre-release deployments e.g. false
falseMaximum allowed total cost for all deployments in this environment in USD e.g. 1000.50
1000.5Updated information about the environment
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment not found
Too many requests
Clone an existing environment with properties and policies
🔒 Requires the create:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe environment name e.g. Production Europe
Production EuropeInformation about cloned environment
Failed to clone the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:environment permission
Environment not found
Too many requests
List environment properties
🔒 Requires the read:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of environment properties
Failed to list environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Environment not found
Too many requests
Create environment props
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of new environment properties
The property name e.g. max_size
max_sizeThe property value or content e.g. 10
10Indicates whether the environment property takes precedence over any provided value e.g. true
falseExample: trueUpdated environment properties
Failed to create environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment not found
Environment prop already exists
Too many requests
Update environment props
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of updated environment properties
The property ID e.g. 123e4567-e89b-12d3-a456-426614174000
The property name e.g. max_size
max_sizeThe property value or content e.g. 10
10Indicates whether the environment property takes precedence over any provided value e.g. true
falseExample: trueUpdated environment properties
Failed to update environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment or prop not found
Environment prop already exists
Too many requests
Delete environment props
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeUpdated environment props
Failed to delete environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment or prop not found
Too many requests
List packages allowed to be deployed in the environment
🔒 Requires the read:package permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeResults offset to allow pagination e.g. 10
0Example: 10Results limit to allow pagination, e.g. 50
20Example: 10Enables searching within the list for package names that match a particular query e.g. sns
List of packages allowed in the environment
Failed to get packages list
Failed to authenticate user
User not assigned to environment. 🔒 Requires the read:package permission
User / Organization not found
Too many requests
List environment secrets
🔒 Requires the read:secret permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of environment secrets
Failed to list environment secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:secret permission
Environment not found
Too many requests
Create environment secrets
🔒 Requires the create:secret permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of new environment-scoped secrets
The secret key e.g. API_TOKEN
API_TOKENThe secret encrypted value e.g. ERJZ7ZOJcNpQEAvrb6wPOA==
ERJZ7ZOJcNpQEAvrb6wPOA==Updated environment secrets
Failed to create environment secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:secret permission
Environment not found
Secret with such key already exists
Too many requests
Update environment secrets
🔒 Requires the update:secret permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of updated environment-scoped secrets
The secret ID e.g. 123e4567-e89b-12d3-a456-426614174000
The secret key e.g. API_TOKEN
API_TOKENThe secret encrypted value e.g. ERJZ7ZOJcNpQEAvrb6wPOA==
ERJZ7ZOJcNpQEAvrb6wPOA==Updated environment secrets
Failed to update environment secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:secret permission
Environment or secret with provided key not found
Secret with such key already exists
Too many requests
Delete environment secrets
🔒 Requires the delete:secret permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of secret keys to delete within the environment
Updated environment secrets
Failed to delete environment secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:secret permission
Environment or secret with provided key not found
Too many requests
List available environment secrets for the user's organization
🔒 Requires the read:environment permission
Specifies the attribute by which the returned list should be sorted ' +
'e.g. name
created_atPossible values: Specifies the order - ascending or descending - by which the returned list should be sorted e.g. ASC
Results offset to allow pagination e.g. 10
0Example: 10Results limit to allow pagination, e.g. 50
20Example: 10Structure: [key1=value1,key2=value2&value3]
Enables searching within the list for Secret Keys that match a particular query e.g. api_key
List of available environment secrets
Failed to list available environment secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Users assigned to the environment not found
Too many requests
Update environment policies
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of environment policies to update
The name of the policy
require_owner_approvalPossible values: Whether to enable or disable the policy
Updated policy information
Failed to update environment policy
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment not found
Too many requests
List available environments for the user's organization
🔒 Requires the read:environment permission
If false, return active environments only. If true, return all environments
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
Structure: [key1=value1,key2=value2&value3]
Results limit to allow pagination, e.g. 50
20Example: 10Specifies the attribute by which the returned list should be sorted ' +
'e.g. name
createdPossible values: Enables searching within the list for environment names that match a particular query e.g. prod
List of available deployment environments
Failed to list available environments
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Blueprint provided for filtering not found
Too many requests
Failed to list available environments
List available Environment properties of an organization
🔒 Requires the read:environment permission
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
Structure: [key1=value1,key2=value2&value3]
Results limit to allow pagination, e.g. 50
20Example: 10Specifies the attribute by which the returned list should be sorted ' +
'e.g. name
created_atPossible values: Enables searching within the list for environment names that match a particular query
The package name with version e.g. @bluebricks/[email protected]
@bluebricks/[email protected]List of available Environment properties of an organization
Failed to list Environment Props of an organization
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:environment permission
Users assigned to the environment not found
Too many requests
Assign a cloud account to an environment
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe cloud ID to associate with the environment e.g. 86a6e0b9-65e4-49cc-8d40-ce5dcfbf4eb6
f27d96be-c486-4075-a926-0ee96775119fIndicate if the cloud is going to be the one used for provisioning in the associated environment
falseProfile is a named configuration of a specific cloud account
secrets-managerUpdated environment
Failed to assign cloud id to environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment or cloud account not found
Cloud account already assigned
Too many requests
Assign a secondary cloud account to an environment
🔒 Requires the update:environment permission
The environment's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe cloud ID to associate with the environment e.g. 86a6e0b9-65e4-49cc-8d40-ce5dcfbf4eb6
f27d96be-c486-4075-a926-0ee96775119fProfile is a named configuration of a specific cloud account
secrets-managerUpdated environment
Failed to assign cloud id to environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment or cloud account not found
Cloud account already assigned
Too many requests
Dissociate cloud id from environment
🔒 Requires the update:environment permission
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eUpdated environment
Failed to dissociate cloud id from environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:environment permission
Environment or cloud account not found
Too many requests
Last updated
Was this helpful?