> ## Documentation Index
> Fetch the complete documentation index at: https://docs.falkordb.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Create instance

> Provision a new Enterprise Single-Zone instance.

Provisions a new Enterprise Single-Zone instance in the requested cloud provider and region. The instance is created asynchronously; poll [Describe](/api-reference/enterprise/single-zone/describe) until `status` is `RUNNING`.

## Authorization

<ParamField header="Cookie" type="string" required>
  Session cookie set by [Sign in](/api-reference/authentication/signin): `omnistrate_token=<jwt>`.
  Browsers send it automatically; other clients must forward it on every request.
</ParamField>

## Query parameters

<ParamField query="subscriptionId" type="string">
  ID of the subscription that owns the instance.
</ParamField>

## Body

<ParamField body="cloud_provider" type="string" required>
  Cloud provider to provision the instance on, for example `aws` or `gcp`.
</ParamField>

<ParamField body="custom_network_id" type="string" required>
  ID of the custom network to provision the instance in.
</ParamField>

<ParamField body="region" type="string" required>
  Region to provision the instance in, for example `us-east-1`.
</ParamField>

<ParamField body="requestParams" type="object" required>
  Instance configuration.

  <Expandable title="requestParams properties">
    <ParamField body="enableEnterpriseModule" type="boolean" default={false} required>
      Enable the FalkorDB enterprise module. Set at creation only.
    </ParamField>

    <ParamField body="enableTLS" type="boolean" default={false} required>
      Enable TLS for database connections. Set at creation only.
    </ParamField>

    <ParamField body="falkordbPassword" type="string" required>
      Default password for the database. Updating this value after deployment restarts the instance.
    </ParamField>

    <ParamField body="falkordbUser" type="string" default="falkordb" required>
      Default username for the database. Set at creation only.
    </ParamField>

    <ParamField body="nodeInstanceType" type="string" default="e2-custom-4-8192" required>
      Compute instance type used for each node. See [Instance configuration](/api-reference/schemas#instance-configuration).
    </ParamField>

    <ParamField body="AOFPersistenceConfig" type="string" default="everysec">
      Append-only file persistence mode. One of `everysec` or `always`. Set at creation only.
    </ParamField>

    <ParamField body="description" type="string" default="FalkorDB Instance">
      Description of the instance.
    </ParamField>

    <ParamField body="falkorDBCacheSize" type="number" default={25}>
      Number of cached query executions. Between `1` and `256`. Set at creation only. Maps to [`CACHE_SIZE`](https://docs.falkordb.com/getting-started/configuration.html#cache_size) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="falkorDBMaxQueuedQueries" type="number" default={50}>
      Maximum number of queries that can be queued. Between `1` and `512`. Set at creation only. Maps to [`MAX_QUEUED_QUERIES`](https://docs.falkordb.com/getting-started/configuration.html#max_queued_queries) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="falkorDBNodeCreationBuffer" type="number" default={16384}>
      Node creation buffer size. Between `256` and `32768`. Set at creation only. Maps to [`NODE_CREATION_BUFFER`](https://docs.falkordb.com/getting-started/configuration.html#node_creation_buffer) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="falkorDBQueryMemCapacity" type="number" default={21474836480}>
      Maximum memory a single query may use, in bytes. Between `5242880` (5 MiB) and `21474836480` (20 GiB). Set at creation only. Maps to [`QUERY_MEM_CAPACITY`](https://docs.falkordb.com/getting-started/configuration.html#query_mem_capacity) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="falkorDBResultSetSize" type="number" default={10000}>
      Maximum number of records returned by a query. Between `0` and `1000000`, where `0` means unlimited. Set at creation only. Maps to [`RESULTSET_SIZE`](https://docs.falkordb.com/getting-started/configuration.html#resultset_size) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="falkorDBTimeoutDefault" type="number" default={0}>
      Default query timeout in milliseconds. Between `0` and `45000`, where `0` disables the timeout. Set at creation only. Maps to [`TIMEOUT_DEFAULT`](https://docs.falkordb.com/getting-started/configuration.html#timeout_default) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="falkorDBTimeoutMax" type="number" default={0}>
      Maximum query timeout in milliseconds. Between `0` and `45000`, where `0` disables the limit. Set at creation only. Maps to [`TIMEOUT_MAX`](https://docs.falkordb.com/getting-started/configuration.html#timeout_max) in the FalkorDB configuration.
    </ParamField>

    <ParamField body="maxMemory" type="string" default="6GB">
      Maximum memory available to the database, for example `6GB`. Do not exceed the memory of the selected instance type.
    </ParamField>

    <ParamField body="name" type="string" default="FalkorDB Instance">
      Human-readable name for the instance.
    </ParamField>

    <ParamField body="numReplicas" type="number" default={2}>
      Number of replicas to deploy. Fixed at `2`.
    </ParamField>

    <ParamField body="RDBPersistenceConfig" type="string" default="low">
      How often the RDB snapshot is written to disk. One of `low`, `medium`, or `high`. Set at creation only.
    </ParamField>
  </Expandable>
</ParamField>

## 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](/api-reference/schemas#instance-configuration) for the full field reference.

## Response

<ResponseField name="id" type="string">
  ID of the resource instance.
</ResponseField>

```json 202 Accepted theme={null}
{
  "id": "instance-abc123"
}
```

## Errors

See [Error](/api-reference/schemas#error) for the shared error response shape.