Documentation Index

Fetch the complete documentation index at: https://docs.rocket.chat/llms.txt

Use this file to discover all available pages before exploring further.

Manage Your Workspaces

Prev Next

As a workspace administrator, you can use your Rocket.Chat Cloud account to view and manage the workspaces connected to your account.

The Cloud portal can display two deployment types:

  • Self-managed: The workspace is deployed and hosted on your own infrastructure. They’re available on all plan tiers.

  • Cloud-hosted: The workspace infrastructure is hosted and managed by Rocket.Chat. They’re available exclusively on premium plans.

The management options available for a workspace depend on its deployment type, current plan, subscription status, account type, and your permissions.

If you need multiple cloud-hosted workspaces under the same account, contact us at support@rocket.chat.

View workspace information

To view the workspaces linked to your Rocket.Chat Cloud account:

  1. Sign in to your Rocket.Chat Cloud account.

  2. Select Workspaces from the sidebar.

  3. Review the list of connected workspaces.

The workspace list contains the following columns:

Column

Description

Name

The name assigned to the workspace.

Domain

The URL or domain through which the workspace is accessed.

Region

The hosting region for a cloud-hosted workspace. Self-managed workspaces are identified as self-hosted.

Deployment

Indicates whether the workspace is SaaS/cloud-hosted or Self-managed.

Current Plan

The workspace’s current subscription or edition, such as Community, Starter, or Enterprise.

Status

The current workspace status, such as Active, Canceling, or Canceled.

Action

Opens the workspace action menu. The available actions vary by workspace type and subscription.

Select a workspace to open its details page. Depending on the deployment type and plan, the page can include information such as:

  • Plan information: Current plan, pricing, billing frequency, subscription period, or renewal information.

  • Subscription actions: Options such as Subscribe, Compare plans, or Contact sales, depending on the plan and account type.

  • User usage: The number of active users and currently connected users, where applicable.

  • Storage usage: The amount of storage currently used and the workspace storage limit, where applicable.

  • Push notification usage: The number of push notifications sent during the selected period and the applicable limit.

  • Usage history: Monthly or daily push notification usage for the selected date.


Understand available workspace actions

Select the kebab menu (⋮) next to a workspace to view the actions currently available for it.

The menu is contextual, so not every workspace displays the same actions. For example:

Workspace condition

Actions that may be available

Self-managed workspace on Community Edition

Upgrade to Starter, Remove

Self-managed workspace with an active paid subscription, such as Starter

Cancel subscription

Cloud-hosted workspace

Restart, Update

Existing self-service cloud workspace

Cancel

Standard cloud customers with sales-managed subscriptions cannot manage subscription cancellations through the Cloud Portal. Contact Rocket.Chat Sales or Support for assistance.

An action may also be unavailable because of the workspace status, subscription arrangement, or your account permissions.


Restart a cloud-hosted workspace

Restarting can help resolve temporary issues with a cloud-hosted workspace, such as unresponsiveness or delayed message delivery.

Restarting temporarily disconnects users while the workspace services restart. It does not remove workspace data or settings. The process usually takes a few minutes depending on the number of users.

To restart a workspace:

  1. From the Workspaces list, select the kebab menu (⋮) next to the cloud-hosted workspace.

  2. Select Restart.

  3. Wait for the restart request to be processed.

  4. Allow a few minutes for the workspace to become available again.


Update a cloud-hosted workspace

Keeping your workspace up to date gives you access to the latest features, improvements, and security fixes.

To view the version currently running on your workspace, sign in to the workspace and go to Manage → Workspace. The Deployment section displays the current Rocket.Chat server version and may indicate when a newer version is available.

For eligible cloud-hosted workspaces, you can initiate an update from the Rocket.Chat Cloud portal:

  1. From the Workspaces list, select the kebab menu (⋮) next to the cloud-hosted workspace.

  2. Select Update.

  3. In the confirmation window, select the Rocket.Chat version you want to install.

  4. Review the update details and select Yes, update my workspace.

  5. Wait for the update to complete before reconnecting to the workspace.

The update process typically takes 15–30 minutes. Once it is complete, refresh the workspace and verify the running version under Manage → Workspace.

Watch the following video to learn how to restart a cloud-hosted workspace and update its Rocket.Chat version from the Cloud portal.


Cancel a workspace subscription

Only workspace administrators can cancel subscriptions for self-service cloud or self-managed workspaces through the Cloud Portal.

The cancellation option available in the Cloud Portal depends on the workspace type and subscription:

  • Self-managed workspace with an eligible paid plan, such as Starter, displays Cancel subscription.

  • Some existing self-service cloud workspaces may display Cancel. The self-service cloud offering is deprecated, but this option may remain available while an existing subscription continues to renew automatically.

  • Standard cloud customers with sales-enabled subscriptions cannot cancel through the Cloud Portal. Contact the Rocket.Chat Sales or Support team for assistance.

Only subscriptions available for self-service cancellation can be canceled through the Cloud Portal.

To cancel a subscription:

  1. From the workspace list, select the kebab menu () next to the workspace.

  2. Select Cancel subscription or Cancel, depending on the option displayed.

  3. Review and confirm the cancellation.

For a self-service cloud workspace, cancellation has the following effects:

  • The workspace status changes to Canceling until the current billing cycle ends.

  • Billing stops at the end of the billing cycle.

  • The workspace then enters a hibernated state, and its status changes to Canceled.

  • You can request restoration within 30 days by contacting support@rocket.chat. After this period, you must create a new workspace.


Remove a self-managed workspace

The Remove option is available for self-managed workspaces on the Community Edition plan that do not have an active paid subscription.

If the workspace has an active paid plan, you must first cancel the subscription. The workspace remains on the paid plan until the end of the current billing cycle. After the subscription ends and the workspace is downgraded to Community Edition, you can remove it from your Rocket.Chat Cloud account.

Removing a workspace unregisters it from your Cloud account and removes it from the Cloud Portal workspace list. It does not uninstall the workspace or delete the data stored on your infrastructure.

To remove a workspace:

  1. From the workspace list, locate the self-managed Community Edition workspace.

  2. Select the kebab menu () next to the workspace.

  3. Select Remove.

  4. Confirm the removal.