Version: Weekly Build

Connect to Your Workspace via SSH

This guide will walk you through setting up Secure Shell (SSH) access for your workspaces. This allows you to securely connect to and interact with your development environment directly from your local terminal.

Key Management

We are currently rolling this feature out in phases. Managing your authorized SSH keys is currently handled exclusively via our Public API. However, retrieving your workspace connection string is fully supported within the Workspace dashboard.

Prerequisites

Before attempting to connect, ensure you have completed the following:

An SSH Key Pair generated on your local machine. If you need to generate one, open your local terminal and run:
ssh-keygen -t ed25519 -C "[email protected]"
A valid Public API Token to authenticate your key management requests. See Public API documentation for details.

Add Your SSH Key (Public API)

Register a New Public Key

Send a POST request to upload your public key. Replace <YOUR_API_TOKEN> with your actual authentication token and paste your public key string into the publicKey field.

Endpoint: POST https://<YOUR_DOMAIN>/api/ssh/keys
Headers:
- Authorization: Bearer <YOUR_API_TOKEN>
- Content-Type: application/json

curl -X POST https://dev-codesphere.com/api/ssh/keys \
 -H "Authorization: Bearer <YOUR API TOKEN>" \
 -H "Content-Type: application/json" \
 -d '{  "publicKey": "<YOUR PUBLIC KEY>"  }'

View Your Registered Keys

To see a list of all public keys currently authorized to access your workspaces, send a GET request:

curl -X GET https://dev-codesphere.com/api/ssh/keys \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Remove an SSH Key

If you need to revoke access for a specific key, issue a DELETE request:

curl -X DELETE https://dev-codesphere.com/api/ssh/keys \
  -H "Authorization: Bearer <YOUR API TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "publicKeyFingerprint": "<YOUR PUBLIC KEY FINGERPRINT>"
  }'