Configure an Instance

After you have created an Instance, you can configure it to your needs. This includes changing the Instance type, compute nodes, and capabilities. To do this, click on the Configure Instance button on the Instance card; this will open up a configuration drawer.

Instance Configuration

In the Instance configuration drawer, you can change the following settings:

• Capabilities: the capabilities of the Instance, this controls the functionality available to users such as scripting, guest access, enabled endpoints for RPC and HTTP endpoints. You can also opt into beta features and restrict access to specific resources.
• Version: the version of SurrealDB that will be used for the Instance. If you a new version is available, you will be prompted to upgrade and also see the release notes.
• Instance type: the type of the Instance.
• Disk Size: the size of the storage disk

Instance capabilities

The capabilities you choose will determine the features available to your Instance. This includes scripting, guest access, enabled endpoints for RPC and HTTP and more. For RPC methods, HTTP endpoints and preview features, you can leave pick one of the following options:

• Managed default: SurrealDB will manage the endpoints for you.
• Allow all by default: All endpoints are allowed by default and you can then select which endpoints to deny.
• Deny all by default: All endpoints are denied by default and you can then select which endpoints to allow.

On the other hand network access and functions provide a more granular control over the endpoints.

Instance type

While the Instance type you choose will determine the compute and memory available to your Instance. When you hit the 0.25 vCPU / 512MB memory free tier limit, you can upgrade your plan to a higher tier using this option.

First, select the Instance type option which will open a modal to select the tier you want to upgrade to as shown below. Depending on the tier you choose, and the resources you have allocated, you will be billed accordingly.

Disk Size

The disk size is the amount of storage available to your Instance. This is used to store the database files and can be increased at any time. For paid plans, you can increase the disk size up to the maximum limit of your plan.

Important

The disk size can be increased only once every 6 hours.

Pause or Delete an Instance

From the overview page, you can delete an Instance by clicking the option button on the Instance card and selecting Delete. This will bring up a confirmation modal. Once confirmed, the Instance will be deleted.

To pause an Instance, click the option button on the Instance card and select Pause. This will bring up a confirmation modal. Once confirmed, the Instance will be paused.