Skip to main content

​
Prerequisites

  • Have a Heex CLI
  • Have a API_KEY. Must be accessible in your personal space on the Heex cloud platform.

​
Usage

SubcommandDescription
get-storageGet storage information of a workspace.
set-storageSet storage information for a workspace.
Usage: 
./heex workspace SUBCOMMAND [--help]

​
How to get storage information of a workspace

Use get-storage to retrieve storage information from your workspace. Information provided includes cloud provider, region, path, name … see example below for more details. Options:
  • -k, --api-key: Your user secret key (required)
Usage: 
./heex workspace get-storage --api-key <API_KEY>
Example: 
❯ ./heex workspace get-storage --api-key xx-xxxxxxxxxxxxxxxxxxxxxxxxxxxx-1
[get_storage][INFO] {
  "key": "AKIA5Fxxxxxxxxxxxxxxxxxxx",
  "name": "my_custom_bucket",
  "path": "recording",
  "provider": "BucketProviderS3",
  "region": "eu-central-1",
  "secret": "xxxxxxxxxxxxxxxxxxx+I859/xxxxxxxxxxxxxxxx"
}

❯ ./heex workspace get-storage --api-key xx-xxxxxxxxxxxxxxxxxxxxxxxxxxxx-2
[get_storage][INFO] You are currently using the default storage system.

​
How to set storage information for a workspace

Use set-storage to configure or modify the storage information on your workspace. You’ll need to provide all information below to be able to set a new storage configuration. Options:
  • -k, --api-key: Your user secret key (required)
  • --provider [AWS|Google|Azure]: The storage provider.
  • --bucket TEXT: Bucket name (required)
  • --region TEXT: Region name (required)
  • --path TEXT: Path in the bucket (required)
  • --bucket-key TEXT: Bucket access key ID (required)
  • --bucket-secret-key TEXT: Bucket secret access key (required)
Usage: 
./heex workspace set-storage -k <API_KEY> \
  --provider <YourProvider> \
  --bucket <BucketName> \
  --region <RegionName> \
  --path <PathInBucket> \
  --bucket-key <AccessKeyID> \
  --bucket-secret-key <SecretAccessKey>
Example: 
❯ ./heex workspace set-storage --api-key xx-xxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  --provider AWS \
  --bucket my-bucket \
  --region eu-central-1 \
  --path recording \
  --bucket-key AKIxxxxxxxxxxxxxxx \
  --bucket-secret-key AfB5xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Getting Help

./heex workspace --help
./heex workspace get-storage --help
./heex workspace set-storage --help
⌘I