Skip to main content
POST
Create instance
Provisions a new Free instance in the requested cloud provider and region. The instance is created asynchronously; poll Describe until status is RUNNING.

Authorization

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

Query parameters

string
ID of the subscription that owns the instance.

Body

string
required
Cloud provider to provision the instance on, for example aws or gcp.
string
required
Region to provision the instance in, for example us-east-1.
object
required
Instance configuration.

Sizing and tier availability

The Free tier is fixed size and does not expose any sizing parameters. Only name, description, falkordbUser, and falkordbPassword are available on the Free tier. Sizing, TLS, persistence, and the falkorDB* tuning parameters are not configurable. See Instance configuration for the full field reference.

Response

string
ID of the resource instance.
202 Accepted

Errors

See Error for the shared error response shape.