Collections
Describe Collection with associated cloud accounts
🔒 Requires the read:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeInformation about the collection
Information about the collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection was deleted e.g. true
The date and time the resource was created e.g. 2022-01-01T00:00:00.000Z
Whether the collection requires approval for install or uninstall e.g. false
falseMaximum allowed total cost for all environments in this collection in USD e.g. 1000.50
1000.5Current total cost for all environments in this collection in USD e.g. 1000.50
1000.5Failed to get collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Collection not found
Too many requests
Failed to get collection
Delete a collection from the organization
🔒 Requires the delete:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeUpdated information about the collection
Updated information about the collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:collection permission
Collection not found
Too many requests
Create a collection for deploying blueprints
🔒 Requires the create:collection permission
The collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection is the default for the organization e.g. true
Information about created collection
Information about created collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 a collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:collection permission
Too many requests
Enable a collection
🔒 Requires the update:collection permission
Updated information about the collection
Updated information about the collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection not found
Too many requests
Disable a collection
🔒 Requires the delete:collection permission
Updated information about the collection
Updated information about the collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:collection permission
Collection not found
Too many requests
Change default collection for the organization
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeUpdated information about the collection
Updated information about the collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection not found
Too many requests
Update collection 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:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseMaximum allowed total cost for all environments in this collection in USD e.g. 1000.50
1000.5Updated information about the collection
Updated information about the collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 environments in this collection in USD e.g. 1000.50
1000.5Failed to update the collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection not found
Too many requests
Clone an existing collection with properties and policies
🔒 Requires the create:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe collection name e.g. Production Europe
Production EuropeInformation about cloned collection
Information about cloned collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:collection permission
Collection not found
Too many requests
List collection properties
🔒 Requires the read:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of collection properties
List of collection properties
Failed to list collection props
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Collection not found
Too many requests
Create collection props
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of new collection properties
The property name e.g. max_size
max_sizeThe property value or content e.g. 10
10Indicates whether the collection property takes precedence over any provided value e.g. true
falseExample: trueUpdated collection properties
Updated collection properties
Failed to create collection props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection not found
Collection prop already exists
Too many requests
Update collection props
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of updated collection 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 collection property takes precedence over any provided value e.g. true
falseExample: trueUpdated collection properties
Updated collection properties
Failed to update collection props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection or prop not found
Collection prop already exists
Too many requests
Delete collection props
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeUpdated collection props
Updated collection props
Failed to delete collection props
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection or prop not found
Too many requests
List packages allowed to be deployed in the collection
🔒 Requires the read:package permission
The collection'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 collection
List of packages allowed in the collection
Failed to get packages list
Failed to authenticate user
User not assigned to collection. 🔒 Requires the read:package permission
User / Organization not found
Too many requests
List collection secrets
🔒 Requires the read:secret permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of collection secrets
List of collection secrets
Failed to list collection secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:secret permission
Collection not found
Too many requests
Create collection secrets
🔒 Requires the create:secret permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of new collection-scoped secrets
The secret key e.g. API_TOKEN
API_TOKENThe secret encrypted value e.g. ERJZ7ZOJcNpQEAvrb6wPOA==
ERJZ7ZOJcNpQEAvrb6wPOA==Updated collection secrets
Updated collection secrets
Failed to create collection secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:secret permission
Collection not found
Secret with such key already exists
Too many requests
Update collection secrets
🔒 Requires the update:secret permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of updated collection-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 collection secrets
Updated collection secrets
Failed to update collection secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:secret permission
Collection or secret with provided key not found
Secret with such key already exists
Too many requests
Delete collection secrets
🔒 Requires the delete:secret permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of secret keys to delete within the collection
Updated collection secrets
Updated collection secrets
Failed to delete collection secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the delete:secret permission
Collection or secret with provided key not found
Too many requests
List available collection secrets for the user's organization
🔒 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 collection secrets
List of available collection secrets
Failed to list available collection secrets
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Users assigned to the collection not found
Too many requests
Update collection policies
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeList of collection 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 collection policy
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection not found
Too many requests
List available collections for the user's organization
🔒 Requires the read:collection permission
If false, return active collections only. If true, return all collections
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 collection names that match a particular query e.g. prod
List of available collections
List of available collections
Failed to list available collections
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 collections
List available Collection properties of an organization
🔒 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 collection names that match a particular query
The package name with version e.g. @bluebricks/[email protected]
@bluebricks/[email protected]List of available Collection properties of an organization
List of available Collection properties of an organization
Failed to list Collection Props of an organization
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:collection permission
Users assigned to the collection not found
Too many requests
Assign a cloud account to a collection
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe 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 collection
falseProfile is a named configuration of a specific cloud account
secrets-managerUpdated collection
Updated collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection or cloud account not found
Cloud account already assigned
Too many requests
Assign a secondary cloud account to a collection
🔒 Requires the update:collection permission
The collection's slug or ID e.g. prod | f27d96be-c486-4075-a926-0ee96775119d
production-europeThe 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 collection
Updated collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eThe collection slug e.g. production-europe
production-europeThe collection name e.g. Production Europe
Production EuropeThe collection color code e.g. #0000ff
#0000ffPattern: ^#(?:[0-9a-fA-F]{3}){1,2}$Whether the collection allows pre-release deployments e.g. false
falseWhether the collection is the default for the organization e.g. true
Indicate if the collection is active e.g. true
Indicate if the collection 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 collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection or cloud account not found
Cloud account already assigned
Too many requests
Dissociate cloud id from collection
🔒 Requires the update:collection permission
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eUpdated collection
Updated collection
The collection's ID e.g. f27d96be-c486-4075-a926-0ee96775119e
f27d96be-c486-4075-a926-0ee96775119eFailed to dissociate cloud id from collection
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:collection permission
Collection or cloud account not found
Too many requests
Last updated
Was this helpful?