Skip to main content
POST
Connect to a workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceID
string<uuid>
required

Query Parameters

start
boolean

Permit this connect to start the workspace. Omitted or false attaches only: a workspace that is not already usable answers 409 with the conflict union, discriminated by kind.

Response

OK

display_state
enum<string>
required
Available options:
deleted,
idle,
starting,
stopping,
suspending,
ready,
preparing,
error,
stopped,
suspended
state
enum<string>
required
Available options:
running
transport
object
required
workspace_id
string<uuid>
required
last_started_at
string
Minimum string length: 1
operation
object