Package
Get extended package details
🔒 Requires the read:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3Return slim version of bricks.json if exists
falsePackage info and bricks.json content
Failed to fetch package information
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Package not found
Too many requests
Publish a bricks.json-based blueprint to the package registry. Supports both traditional bricks.json format and new slim bricks.yaml format. The package will be uploaded to the provided namespace.
If no namespace is provided, it will be uploaded to the organization namespace by default. This ensures that packages are properly organized and accessible within the appropriate scope.
Supported formats:
bricks.json: Traditional full-format blueprintbricks.json(slim): Slim format in JSON (automatically converted to "traditional" format)bricks.yaml/bricks.yml: YAML declarative format (automatically converted to "traditional" format)
🔒 Requires the create:package permission
The blueprint configuration file. Supports bricks.json ("traditional" and "slim" version), bricks.yaml
Set to true if the provided bricks file is in slim format (YAML or JSON). If false or not provided, the file is expected to be in traditional bricks.json format
falseThe package content, zipped (required only for native packages)
Whether the package includes initial state, e.g. true
falseThe git commit hash of the package source
8f63e821f0df35c1f0c354c2ce15d5f8a65a6039The git remote url of the package repository
https://github.com/username/repository.gitThe git branch name the package was created from
mainThe git subdirectory path of the package repository
path/to/subdirectorySHA-256 hash of the artifact files for collision validation purposes (relevant only for packages of type artifact)
ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015adPattern: ^[a-fA-F0-9]{64}$Optional original slim bricks file provided during CLI publishing
Information about published package
Failed to publish package
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:package permission
Child package not found
Package or version already exists or namespace is taken
Too many requests
Failed to publish package due to an internal error
List the available versions of a package
🔒 Requires the read:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcfalsePackage info and list of versions
Failed to fetch package version information
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Package not found
Too many requests
Get the last message from a publisher status stream by job ID. Returns the latest status update including progress, message, and status information.
🔒 Requires the read:package permission
Unique identifier for the publisher status stream job
123e4567-e89b-12d3-a456-42661417400Last message from the publisher stream
Bad request
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Redis stream not found
Too many requests
Failed to get message from Redis stream
Search through published packages
🔒 Requires the read:package 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
Results limit to allow pagination, e.g. 50
10Example: 10Search query e.g. blue*, *blue
Specifies the attribute by which the returned list should be sorted
List of packages matching the query
Failed to search through packages
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Author of package not found
Too many requests
Return package filters
🔒 Requires the read:package permission
Package filters
Bad request
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Too many requests
Failed to get package filters
Provide the status of a specific package for the account. Mostly used to indicate if package is already enabled for an account
🔒 Requires the read:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3Include pre-release versions
List of enabled versions of a package
Failed to get enabled package versions list
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Package not found
Too many requests
Validate package properties
🔒 Requires the read:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3List of properties to validate if they are customizable e.g. ["bucket_name.region", "vpc_id"]
Validation result for package properties
Failed to validate package properties
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Package not found
Too many requests
Enable package version/s within the org
🔒 Requires the update:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3Package version/s enabled
Failed to enable package version/s
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:package permission
Package not found
Too many requests
Disable package version/s within the org
🔒 Requires the update:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3Package version/s disabled
Failed to disable package version/s
Failed to authenticate user
Missing required scopes. 🔒 Requires the update:package permission
Package not found
Too many requests
Install package on remote cloud
🔒 Requires the create:deployment permission
Validate package for installation without execution
falseThe package name, e.g. @bluebricks/postgres. Optional if planId is provided
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3Force installation without approval
Plan the installation/uninstall without executing
falseEnable incremental mode to skip deployments with no changes
falseExecute drift detection for the deployment
falseEnable drift detection for the deployment
falseTarget environment for installation
The default environment of the organizationProvides a slug for a newly created deployment. Cannot be specified if deployment was provided
Identify a previous deployments using its ID or slug for the same package in the same environment to share state and slug e.g. postgres-prod or 5ecbb18d-04c7-4298-b550-ab12bf661477
Created task id for installation process or validate installation
Failed to start installation
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:deployment permission
Package not found or not enabled for organization
Deployment slug already exists
Too many requests
Failed to start installation
Uninstall package from cloud
🔒 Requires the create:deployment permission
Deployment ID or slug to target for uninstall e.g. aws-single-ec2-development-1 or 797746e4-07a0-4aed-bb15-89dd9a7c413a
Plan the installation/uninstall without executing
falseCreated task id for uninstall process
Failed to start uninstall process
Failed to authenticate user
Missing required scopes. 🔒 Requires the create:deployment permission
Package not found or not enabled for organization
Too many requests
Load package by name and version
🔒 Requires the read:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3Presigned URL for package download
Failed to generate presigned url to download package
Failed to authenticate user or runtime
Missing required scopes. 🔒 Requires the read:package permission
Package not found
Too many requests
Get package properties with their values, sources, and metadata for a specific deployment context
🔒 Requires the read:package permission
The package name e.g. @bluebricks/aws-vpc
@bluebricks/aws-vpcThe package version e.g. 1.2.3
1.2.3The environment slug e.g. production-europe
production-europeThe deployment's ID or slug e.g. f27d96be-c486-4075-a926-0ee96775119e or my-deployment
Package properties with their metadata
Invalid request parameters
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Package, environment, or deployment not found
Too many requests
Failed to retrieve package properties
List packages used by organization
🔒 Requires the read:package permission
When true, returns all packages including those that were already deployed. When false, returns only not-deployed packages.
When true, returns only the latest version for each package
Specifies the attribute by which the returned list should be sorted e.g. name
createdPossible 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 package names that match a particular query e.g. sns
Last completed deployments for an environment
Failed to get deployments list
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
User / Organization not found
Too many requests
Compare package file hashes to identify changed packages
🔒 Requires the read:package permission
Comparison result with changed and unchanged packages
Failed to compare package changes
Failed to authenticate user
Missing required scopes. 🔒 Requires the read:package permission
Too many requests
Last updated
Was this helpful?