Skip to content

Add SSH and IDE connection info to runs API#3681

Open
un-def wants to merge 1 commit intomasterfrom
issue_3644_sshproxy_server_configuration
Open

Add SSH and IDE connection info to runs API#3681
un-def wants to merge 1 commit intomasterfrom
issue_3644_sshproxy_server_configuration

Conversation

@un-def
Copy link
Collaborator

@un-def un-def commented Mar 19, 2026

/api/project/:project/runs/get now returns a new structure with connection info for each running job within a run.

The info includes:

  • SSH command to connect (all configurations)
  • IDE name and URL (dev-environments only)

Both command and IDE URL have two flavors:

  • attached – for use with CLI attached to the run
  • proxied – for use with sshproxy component (optional)

Part-of: #3644

`/api/project/:project/runs/get` now returns a new structure with
connection info for each running job within a run.

The info includes:

* SSH command to connect (all configurations)
* IDE name and URL (dev-environments only)

Both command and IDE URL have two flavors:
* attached – for use with CLI attached to the run
* proxied – for use with sshproxy component (optional)

Part-of: #3644
@un-def
Copy link
Collaborator Author

un-def commented Mar 19, 2026

How to test:

  1. Start sshproxy as described in its README
  2. Start dstack server with environment variables:
    • DSTACK_SSHPROXY_API_TOKEN=<sshproxy-api-token>,
    • DSTACK_SERVER_SSHPROXY_ADDRESS=localhost:30022
    • DSTACK_FF_CLI_PRINT_JOB_CONNECTION_INFO=1
  3. dstack apply -f dev-environment.dstack.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant