SEseqeralabs
studios

Create Studio

Changed on

Creates a new Studio environment, starting it by default. Default behavior can be changed using the query parameter autoStart=false.

post/studios

Request

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

Query parameters

workspaceIdinteger

Workspace numeric identifier

autoStartboolean

Optionally disable the Studio's automatic launch when it is created.

Request body

allowedUserIdsinteger[] nullable
computeEnvIdstring required
customIconIdstring nullable

Avatar id (from POST /avatars) for the Studio session icon. Semantics on create: null = inherit from the parent checkpoint (if any); empty string = explicit clear (no icon, even if a parent checkpoint has one); non-empty = assign the referenced Avatar.

dataStudioToolUrlstring
descriptionstring
initialCheckpointIdinteger
isPrivateboolean
labelIdsinteger[] nullable
namestring required
spotboolean nullable

Response

CreateDataStudio 200 response

Example response

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

Changes

  • 0e1a1696f553Revision changes
    • info

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

    • 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

    • 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