Instance management

Learn how to create, edit, configure, and manage your instances.

Create a new instance

Before you begin:

• Instances support two permission types: instance editor and instance viewer. Learn more about instance-level roles.

• Make sure the correct permissions are set before granting access. Only space administrators can grant instance access rights.

Follow our visual guide to create an instance:

Creating a new instance

Step-by-step instructions:

1. Navigate to the space where you want to create the instance.

2. Click the Project Users icon in the Manage section of the right-hand menu panel on the overview screen.

3. Click Invite in the top right corner of the Project Users menu, then click Add new instance in the Invite To field.

4. Choose whether to start from a snapshot or create an empty instance.

5. Fill in the instance name and description.

6. Invite users if you'd like to add collaborators right away.

Create a shared instance

Here's how to create an instance and add collaborators:

1. Open your space (course or research project). In this example, we're opening "Demo Space".

1. From the overview screen, click "Course Users".

1. Navigate to the "INSTANCES" tab and click "ADD NEW INSTANCE".

1. Choose between creating an empty instance or one with snapshot contents, then click "CONTINUE".

1. Enter a name and description for your instance.

1. Once created, click "INVITE".

1. Enter the email addresses of users who will share this instance and click "INVITE".

Edit an instance

Important notes:

• Instance editors and space administrators can edit instance names and descriptions

• Master and Distributed instances cannot be edited

• Both name and description fields have a maximum length of 1023 characters

To edit an instance:

1. Open your space (course or research project).

2. From the overview screen, click "Course Users" (or "Project Users" depending on your space type).

3. Go to the "INSTANCES" tab to view all instances in the space.

4. Find the instance you want to edit and click the pencil icon next to it.

5. In the Edit Instance dialog:

   • Update the Name field if you want to change the instance name

   • Update the Description field if you want to change the instance description

   • Both fields are required

6. Click "Save Changes" to apply your edits.

The changes will take effect immediately, and the instance list will refresh to show the updated information.

Delete an instance

Important notes:

• Only space administrators can delete instances

• Master and Distributed instances cannot be deleted

To delete an instance:

1. Open your space (course or research project). In this example, we're opening "Demo Space".

1. From the overview screen, click "Course Users".

1. Go to the "INSTANCES" tab, find the instance you want to delete, and click the red bin icon on the right. In this example, we're deleting "First group instance".

1. Read the confirmation message carefully. If you agree, click "DELETE".