Skip to main content
PUT
Update instance
Applies configuration changes to a running instance. Only the fields you send are changed. Changing falkordbPassword or nodeInstanceType restarts the instance.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>. Browsers send it automatically; other clients must forward it on every request.

Path parameters

string
required
ID of the resource instance.

Query parameters

string
ID of the subscription that owns the instance.

Body

object
required
Instance configuration.

Sizing and tier availability

nodeInstanceType accepts any compute instance type available to your Enterprise plan in the selected cloud provider and region, for example e2-custom-4-8192 on GCP or m7g.xlarge on AWS. It defaults to e2-custom-4-8192. Use maxMemory to cap the memory the database itself uses; it must not exceed the memory of the selected instance type. maxMemory and enableEnterpriseModule are available on this tier. numReplicas is fixed at 2 for this component and cannot be changed. See Instance configuration for the full field reference.

Response

string
ID of the resource instance.

Errors

See Error for the shared error response shape.