Documentation Index
Fetch the complete documentation index at: https://docs.hotglue.com/llms.txt
Use this file to discover all available pages before exploring further.
View tenants directly from the CLI.
Tenants List
Description
Lists the tenants in the hotglue environment.
Sample
Tenants Delete
Description
Deletes a tenant from hotglue (including scheduled jobs and any related jobs history/config files).
Sample
$ hotglue tenants delete -e prod.acme.com -u test-user
✔ Finished: Deleting tenant test-user schedules.
✔ Finished: Verifying user and authorizing.
✔ Finished: Deleting tenant test-user for environment prod.acme.com.
┌─────────────┐
│ Tenant ID │
├─────────────┤
│ test-user │
└─────────────┘
Tenants Update Config
Description
Bulk updates the configs of all tenants.
This will update the passed JSON into the tenants’ configs, not completely overwrite the tenants’ configs.
Sample
hotglue tenants update-config
✔ Finished: Retrieving tenants for environment dev.hotglue.testcompany.com.
✔ Finished: Updating config for connector salesforce and flow abc123.
┌─────────────┐
│ Tenant ID │
├─────────────┤
│ test-user │
└─────────────┘
Parameters
| Option | Default | Description |
|---|
--flow | | The flow to update linked sources/connectors for |
--connector | | The connector id to update |
--configFilePath | ./config.json | The relative path to a JSON file containing the desired config updates |
Tenants Custom ETL
Description
Lists all tenants with custom ETL Scripts
Sample
hotglue tenants custom-etl
✔ Finished: Retrieving tenants for environment dev.hotglue.test.com.
✔ Finished: Querying for custom ETL scripts for flow ABC123.
┌─────────────┐
│ Tenant ID │
├─────────────┤
│ test-user │
└─────────────┘
Parameters
| Option | Default | Description |
|---|
--flow | | The flow to check for forked scripts |
--connector | | The connector ID to check for forked scripts |
Tenants Custom Field Map
Description
Lists all tenants with a custom Field Map
Sample
hotglue tenants custom-field-map
✔ Finished: Retrieving tenants for environment dev.hotglue.testcompany.com.
✔ Finished: Querying for custom field maps for flow KeJ5dstJ2.
┌──────────────┬──────────┐
│ Tenant ID │ Connector IDs │
├──────────────┼──────────┤
│ anonymous-user-5 │ intacct │
└──────────────┴──────────┘
Parameters
| Option | Default | Description |
|---|
--flow | | The flow to check for forked field maps |
--connector | | The connector ID to check for forked field maps |
Tenants Custom Catalog
Description
Lists all tenants with a custom catalog
Sample
hotglue tenants custom-catalog
✔ Finished: Retrieving tenants for environment dev.hotglue.test.com.
✔ Finished: Querying for custom catalogs for flow abc123.
┌───────┬────────────┐
│ Tenant ID │ Connector IDs │
├───────┼────────────┤
│ qb-user │ quickbooks:sandbox │
├───────┼───────────┤
│ abc31 │ stripe-v2 │
└────────────────────┘
Parameters
| Option | Default | Description |
|---|
--flow | | The flow to check for forked catalogs |
--connector | | The connector ID to check for forked catalogs |
