studios

Lists all available Studios in a user context. Append ?workspaceId to list Studios in a workspace context.

get/studios

Request

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

Query parameters

workspaceIdinteger

Workspace numeric identifier

searchstring

Optional search criteria, allowing free text search on name and templateUrl and keywords: userId, computeEnvId and status.

maxinteger

Pagination max results

offsetinteger

Pagination offset

attributesDataStudioQueryAttribute[]

Optional attribute values to be included in the response (labels). Returns an empty value (labels: null) if omitted.

Response

OK

totalSizeinteger required

Example response

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

Changes

    • info

      added the optional property //// to the response with 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