Get SSH command for instance
get_ssh_commandReturns the SSH command to connect to an instance via the redu.cloud TCP proxy. ACCEPTS an instance id, a deployment's id / name / instance_id, OR a MANAGED DATASTORE's id / name / instance_id (Postgres, MySQL/MariaDB, ClickHouse, Redis) - it resolves all of them, so you do not have to work out which one you are holding (a deployment's instance_id is a placeholder until provisioning finishes, and passing it used to fail). ⭐ SSH TO THE DATASTORE VM IS HOW YOU REACH A PRIVATE-NETWORK-ONLY DATABASE BEFORE ANY APP VM EXISTS: the datastore's own VM is SSH-reachable and ships the client on PATH (psql at /usr/bin/psql), so you can apply a schema or rotate a seeded admin account without an app VM to tunnel through. For a DEPLOYMENT VM (created by deploy_app/deploy_compose) pass keypair_name — read it from get_deployment — so the command uses -i ~/.ssh/<keypair_name> and authenticates with the RIGHT key instead of your default identity (without it, SSH to a deploy VM usually fails). The tool also best-effort looks up the keypair from the deployment if you omit it. Example: ssh -i ~/.ssh/redu-deploy -o IdentitiesOnly=yes -p 22011 ubuntu@myinstance-abc12345.redu.cloud
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| instance_id | Yes | An instance id, a deployment's id / name / instance_id, or a managed datastore's id / name / instance_id. All are resolved. | |
| keypair_name | No | The SSH keypair the instance was created with (read it from get_deployment for a deploy VM). When given, the command uses `-i ~/.ssh/<keypair_name>` so it authenticates with the right key. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | ||
| mode | No | ||
| port | No | ||
| user | No | ||
| floating_ip | No | ||
| ssh_command | No | ||
| keypair_name | No | ||
| instance_name | No | ||
| instance_status | No |