SEseqeralabs
studios

Update a Studio

Changed on

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}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

sessionIdstring required

Studio session numeric identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

Request body

computeEnvIdstring nullable
customIconIdstring nullable

Avatar id (from POST /avatars) for the Studio session icon. Semantics on update: null = leave the existing icon unchanged (partial-PATCH-safe); empty string = clear the icon and delete the previous Avatar; non-empty = assign the referenced Avatar and delete the previous one if any.

descriptionstring nullable
labelIdsinteger[] nullable
namestring nullable

Response

OK

baseImagestring nullable
customIconstring nullable

Resolved URL for the Studio's user-uploaded icon. Server-derived at read time from the underlying Avatar FK against the current towerPublicEndpoint, so it always reflects the installation's public URL (survives Enterprise domain changes / DB restores). Null when unset — frontends should fall back to the template tool logo.

customIconIdstring nullable

Avatar id backing customIcon. Exposed so clients can round-trip an unchanged icon back to the server on create/update/start without re-parsing the URL. Null when unset.

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

Example response

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

Changes

  • 0e1a1696f553Revision changes
    • info

      added the optional property // to the response with the status

  • 24f327d93421Revision changes
    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      the request property ///// became nullable