Environments (Deprecated)
DEPRECATED: Use GET /api/v1/collection/:idOrSlug instead. Describe Environment with associated cloud accounts (legacy environment endpoint).
🔒 Requires the read:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
Information about the environment
Information about the environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
Whether the environment requires approval for install or uninstall e.g. false
falseMaximum allowed total cost for all deployments in this environment in USD e.g. 1000.50
1000.5Current total cost for all deployments in this environment in USD e.g. 1000.50
1000.5Failed to get environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Environment not found
Too many requests
Failed to get environment
DEPRECATED: Use DELETE /api/v1/collection/:idOrSlug instead. Delete an environment from the organization (legacy environment endpoint).
🔒 Requires the delete:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
Updated information about the environment
Updated information about the environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Failed to delete the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:collection permission
Environment not found
Too many requests
DEPRECATED: Use POST /api/v1/collection instead. Create an environment for deploying blueprints (legacy environment endpoint).
🔒 Requires the create:collection 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
Information about created environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Failed to create an environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:collection permission
Too many requests
DEPRECATED: Use PUT /api/v1/collection instead. Enable an environment (legacy environment endpoint).
🔒 Requires the update:collection permission
Updated information about the environment
Updated information about the environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment not found
Too many requests
DEPRECATED: Use DELETE /api/v1/collection instead. Disable an environment (legacy environment endpoint).
🔒 Requires the delete:collection permission
Updated information about the environment
Updated information about the environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:collection permission
Environment not found
Too many requests
DEPRECATED: Use PUT /api/v1/collection/:idOrSlug/default instead. Change default environment for the organization (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
Updated information about the environment
Updated information about the environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment not found
Too many requests
DEPRECATED: Use PATCH /api/v1/collection/:idOrSlug/edit instead. 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 (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
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 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
Updated information about the environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Maximum allowed total cost for all deployments in this environment in USD e.g. 1000.50
1000.5Failed to update the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment not found
Too many requests
DEPRECATED: Use PUT /api/v1/collection/:idOrSlug/clone instead. Clone an existing environment with properties and policies (legacy environment endpoint).
🔒 Requires the create:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
The environment name e.g. Production Europe
Production EuropeInformation about cloned environment
Information about cloned environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
The cloud account ID e.g. 12345678-1234-1234-1234-123456789012
Failed to clone the environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:collection permission
Environment not found
Too many requests
DEPRECATED: Use GET /api/v1/collection/:idOrSlug/props instead. List environment properties (legacy environment endpoint).
🔒 Requires the read:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List of environment properties
List of environment properties
Failed to list environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Environment not found
Too many requests
DEPRECATED: Use POST /api/v1/collection/:idOrSlug/props instead. Create environment props (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List 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
Updated environment properties
Failed to create environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment not found
Environment prop already exists
Too many requests
DEPRECATED: Use PUT /api/v1/collection/:idOrSlug/props instead. Update environment props (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List 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
Updated environment properties
Failed to update environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment or prop not found
Environment prop already exists
Too many requests
DEPRECATED: Use DELETE /api/v1/collection/:idOrSlug/props instead. Delete environment props (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
Updated environment props
Updated environment props
Failed to delete environment props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment or prop not found
Too many requests
DEPRECATED: Use GET /api/v1/collection/:idOrSlug/blueprints instead. List packages allowed to be deployed in the environment (legacy environment endpoint).
🔒 Requires the read:package permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
Results 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
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
DEPRECATED: Use GET /api/v1/collection/:idOrSlug/settings/secrets instead. List environment secrets (legacy environment endpoint).
🔒 Requires the read:secret permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List of environment secrets
List 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
DEPRECATED: Use POST /api/v1/collection/:idOrSlug/settings/secrets instead. Create environment secrets (legacy environment endpoint).
🔒 Requires the create:secret permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List of new environment-scoped secrets
The secret key e.g. API_TOKEN
API_TOKENThe secret encrypted value e.g. ERJZ7ZOJcNpQEAvrb6wPOA==
ERJZ7ZOJcNpQEAvrb6wPOA==Updated environment secrets
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
DEPRECATED: Use PUT /api/v1/collection/:idOrSlug/settings/secrets instead. Update environment secrets (legacy environment endpoint).
🔒 Requires the update:secret permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List 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
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
DEPRECATED: Use DELETE /api/v1/collection/:idOrSlug/settings/secrets instead. Delete environment secrets (legacy environment endpoint).
🔒 Requires the delete:secret permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List of secret keys to delete within the environment
Updated environment secrets
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
DEPRECATED: Use GET /api/v1/collection/settings/secrets instead. List available environment secrets for the user's organization (legacy environment endpoint).
🔒 Requires the read:collection 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
List of available environment secrets
Failed to list available environment secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Users assigned to the environment not found
Too many requests
DEPRECATED: Use PUT /api/v1/collection/:idOrSlug/settings/policies instead. Update environment policies (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
List of environment policies to update
The name of the policy
require_owner_approvalPossible values: Whether to enable or disable the policy
Updated policy information
Updated policy information
The name of the policy
require_owner_approvalPossible values: Current policy state after update
Failed to update environment policy
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment not found
Too many requests
DEPRECATED: Use GET /api/v1/collections instead. List available environments for the user's organization (legacy environment endpoint).
🔒 Requires the read:collection 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
List of available deployment environments
Failed to list available environments
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Blueprint provided for filtering not found
Too many requests
Failed to list available environments
DEPRECATED: Use GET /api/v1/collections/props instead. List available Environment properties of an organization (legacy environment endpoint).
🔒 Requires the read:collection 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/aws-vpc@1.2.3
@bluebricks/aws-vpc@1.2.3List of available Environment properties of an organization
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:collection permission
Users assigned to the environment not found
Too many requests
DEPRECATED: Use POST /api/v1/collections/:collectionIdOrSlug/cloud/:cloudId instead. Assign a cloud account to an environment (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
The cloud ID to associate with the collection 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
Updated environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
Failed to assign cloud id to environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment or cloud account not found
Cloud account already assigned
Too many requests
DEPRECATED: Use POST /api/v1/collections/:collectionIdOrSlug/cloud/secondary/:cloudId instead. Assign a secondary cloud account to an environment (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-environment
The cloud ID to associate with the collection e.g. 86a6e0b9-65e4-49cc-8d40-ce5dcfbf4eb6
f27d96be-c486-4075-a926-0ee96775119fProfile is a named configuration of a specific cloud account
secrets-managerUpdated environment
Updated environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
The environment's slug e.g. my-environment
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 allows pre-release deployments e.g. false
falseWhether the environment is the default for the organization e.g. true
Indicate if the environment is active e.g. true
Indicate if the environment was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
Failed to assign cloud id to environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment or cloud account not found
Cloud account already assigned
Too many requests
DEPRECATED: Use DELETE /api/v1/collections/:collectionId/cloud/:cloudId instead. Dissociate cloud id from environment (legacy environment endpoint).
🔒 Requires the update:collection permission
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
Updated environment
Updated environment
The environment's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
Failed to dissociate cloud id from environment
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Environment or cloud account not found
Too many requests
Last updated
Was this helpful?