Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Link connectors, sources, and targets to tenants with the hotglue CLI
linked-entities commands to link connectors, sources, and targets to a tenant on a flow. These are the entities that a tenant has connected for a given flow. Use supported-entities get first to discover the connection parameters a connector expects before linking it.
hotglue linked-entities create --env prod.acme.com --flow bTHIweD0W --tenant acme --id shopify
hotglue linked-entities create \
--env prod.acme.com \
--flow bTHIweD0W \
--tenant acme \
--id s3 \
--config '{"bucket":"my-bucket"}'
--entity-type and --flow-version to link another entity type:
# v2 source
hotglue linked-entities create --env prod.acme.com --flow bTHIweD0W --tenant acme --id shopify --entity-type source
# v2 target with configuration
hotglue linked-entities create --env prod.acme.com --flow bTHIweD0W --tenant acme --id s3 --entity-type target --config '{"bucket":"my-bucket"}'
# v1 source
hotglue linked-entities create --env prod.acme.com --flow bTHIweD0W --tenant acme --id shopify --entity-type source --flow-version v1
# v1 target
hotglue linked-entities create --env prod.acme.com --flow bTHIweD0W --tenant acme --id s3 --entity-type target --flow-version v1
hotglue linked-entities create --env prod.acme.com --flow bTHIweD0W --tenant acme --id s3 --json
| Option | Default | Description |
|---|---|---|
--apikey, -k | Profile config | Personal API Key used to authenticate the request. |
--env, -e | Required. Environment containing the flow. | |
--flow, -f | Required. Flow to link the entity to. | |
--tenant, -u | Required. Tenant to link the entity to. | |
--id | Required. ID of an available connector, source, or target. | |
--config | {} | Shell-quoted JSON object containing the entity configuration. |
--entity-type | connector | Entity type. Must be connector, source, or target. |
--flow-version | v2 | Flow version. Must be v1 or v2. |
--json | false | Return machine-readable output. |