v12

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01252498556.8 KB
studios

Update a Studio

Updates the given Studio session ID. Can only update non-running Studios. The compute environment can be changed by setting computeEnvId to a CE compatible with the Studio's current one; see GET /studios/{sessionId}/compatible-ce.

put/studios/{sessionId}

Path parameters

sessionIdstring required

Studio session numeric identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

Request body

computeEnvIdstring nullable
descriptionstring nullable
labelIdsinteger[] nullable
namestring nullable

Response

OK

baseImagestring
customImageboolean
dateCreatedstring date-time
descriptionstring
effectiveLifespanHoursinteger
isPrivateboolean
lastStartedstring date-time
lastUpdatedstring date-time
namestring
sessionIdstring
studioUrlstring
waveBuildUrlstring
workspaceIdinteger

Example response

{
  "sshDetails": {
    "command": "ssh username@sessionId@host -p port"
  }
}