Create instance
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloud_provider": "<string>",
"custom_network_id": "<string>",
"region": "<string>",
"requestParams": {
"enableEnterpriseModule": true,
"enableTLS": true,
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"nodeInstanceType": "<string>",
"AOFPersistenceConfig": "<string>",
"description": "<string>",
"falkorDBCacheSize": 123,
"falkorDBMaxQueuedQueries": 123,
"falkorDBNodeCreationBuffer": 123,
"falkorDBQueryMemCapacity": 123,
"falkorDBResultSetSize": 123,
"falkorDBTimeoutDefault": 123,
"falkorDBTimeoutMax": 123,
"maxMemory": "<string>",
"name": "<string>",
"RDBPersistenceConfig": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone"
payload = {
"cloud_provider": "<string>",
"custom_network_id": "<string>",
"region": "<string>",
"requestParams": {
"enableEnterpriseModule": True,
"enableTLS": True,
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"nodeInstanceType": "<string>",
"AOFPersistenceConfig": "<string>",
"description": "<string>",
"falkorDBCacheSize": 123,
"falkorDBMaxQueuedQueries": 123,
"falkorDBNodeCreationBuffer": 123,
"falkorDBQueryMemCapacity": 123,
"falkorDBResultSetSize": 123,
"falkorDBTimeoutDefault": 123,
"falkorDBTimeoutMax": 123,
"maxMemory": "<string>",
"name": "<string>",
"RDBPersistenceConfig": "<string>"
}
}
headers = {
"Cookie": "<cookie>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Cookie: '<cookie>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cloud_provider: '<string>',
custom_network_id: '<string>',
region: '<string>',
requestParams: {
enableEnterpriseModule: true,
enableTLS: true,
falkordbPassword: '<string>',
falkordbUser: '<string>',
nodeInstanceType: '<string>',
AOFPersistenceConfig: '<string>',
description: '<string>',
falkorDBCacheSize: 123,
falkorDBMaxQueuedQueries: 123,
falkorDBNodeCreationBuffer: 123,
falkorDBQueryMemCapacity: 123,
falkorDBResultSetSize: 123,
falkorDBTimeoutDefault: 123,
falkorDBTimeoutMax: 123,
maxMemory: '<string>',
name: '<string>',
RDBPersistenceConfig: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cloud_provider' => '<string>',
'custom_network_id' => '<string>',
'region' => '<string>',
'requestParams' => [
'enableEnterpriseModule' => true,
'enableTLS' => true,
'falkordbPassword' => '<string>',
'falkordbUser' => '<string>',
'nodeInstanceType' => '<string>',
'AOFPersistenceConfig' => '<string>',
'description' => '<string>',
'falkorDBCacheSize' => 123,
'falkorDBMaxQueuedQueries' => 123,
'falkorDBNodeCreationBuffer' => 123,
'falkorDBQueryMemCapacity' => 123,
'falkorDBResultSetSize' => 123,
'falkorDBTimeoutDefault' => 123,
'falkorDBTimeoutMax' => 123,
'maxMemory' => '<string>',
'name' => '<string>',
'RDBPersistenceConfig' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <cookie>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone"
payload := strings.NewReader("{\n \"cloud_provider\": \"<string>\",\n \"custom_network_id\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"enableEnterpriseModule\": true,\n \"enableTLS\": true,\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"AOFPersistenceConfig\": \"<string>\",\n \"description\": \"<string>\",\n \"falkorDBCacheSize\": 123,\n \"falkorDBMaxQueuedQueries\": 123,\n \"falkorDBNodeCreationBuffer\": 123,\n \"falkorDBQueryMemCapacity\": 123,\n \"falkorDBResultSetSize\": 123,\n \"falkorDBTimeoutDefault\": 123,\n \"falkorDBTimeoutMax\": 123,\n \"maxMemory\": \"<string>\",\n \"name\": \"<string>\",\n \"RDBPersistenceConfig\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<cookie>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloud_provider\": \"<string>\",\n \"custom_network_id\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"enableEnterpriseModule\": true,\n \"enableTLS\": true,\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"AOFPersistenceConfig\": \"<string>\",\n \"description\": \"<string>\",\n \"falkorDBCacheSize\": 123,\n \"falkorDBMaxQueuedQueries\": 123,\n \"falkorDBNodeCreationBuffer\": 123,\n \"falkorDBQueryMemCapacity\": 123,\n \"falkorDBResultSetSize\": 123,\n \"falkorDBTimeoutDefault\": 123,\n \"falkorDBTimeoutMax\": 123,\n \"maxMemory\": \"<string>\",\n \"name\": \"<string>\",\n \"RDBPersistenceConfig\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cloud_provider\": \"<string>\",\n \"custom_network_id\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"enableEnterpriseModule\": true,\n \"enableTLS\": true,\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"AOFPersistenceConfig\": \"<string>\",\n \"description\": \"<string>\",\n \"falkorDBCacheSize\": 123,\n \"falkorDBMaxQueuedQueries\": 123,\n \"falkorDBNodeCreationBuffer\": 123,\n \"falkorDBQueryMemCapacity\": 123,\n \"falkorDBResultSetSize\": 123,\n \"falkorDBTimeoutDefault\": 123,\n \"falkorDBTimeoutMax\": 123,\n \"maxMemory\": \"<string>\",\n \"name\": \"<string>\",\n \"RDBPersistenceConfig\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Cluster (Single-Zone)
Create instance
Provision a new Enterprise Cluster (Single-Zone) instance.
POST
/
2022-09-01-00
/
resource-instance
/
sp-JvkxkPhinN
/
falkordb
/
v1
/
prod
/
falkordb-enterprise-customer-hosted
/
falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy
/
cluster-Single-Zone
Create instance
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloud_provider": "<string>",
"custom_network_id": "<string>",
"region": "<string>",
"requestParams": {
"enableEnterpriseModule": true,
"enableTLS": true,
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"nodeInstanceType": "<string>",
"AOFPersistenceConfig": "<string>",
"description": "<string>",
"falkorDBCacheSize": 123,
"falkorDBMaxQueuedQueries": 123,
"falkorDBNodeCreationBuffer": 123,
"falkorDBQueryMemCapacity": 123,
"falkorDBResultSetSize": 123,
"falkorDBTimeoutDefault": 123,
"falkorDBTimeoutMax": 123,
"maxMemory": "<string>",
"name": "<string>",
"RDBPersistenceConfig": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone"
payload = {
"cloud_provider": "<string>",
"custom_network_id": "<string>",
"region": "<string>",
"requestParams": {
"enableEnterpriseModule": True,
"enableTLS": True,
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"nodeInstanceType": "<string>",
"AOFPersistenceConfig": "<string>",
"description": "<string>",
"falkorDBCacheSize": 123,
"falkorDBMaxQueuedQueries": 123,
"falkorDBNodeCreationBuffer": 123,
"falkorDBQueryMemCapacity": 123,
"falkorDBResultSetSize": 123,
"falkorDBTimeoutDefault": 123,
"falkorDBTimeoutMax": 123,
"maxMemory": "<string>",
"name": "<string>",
"RDBPersistenceConfig": "<string>"
}
}
headers = {
"Cookie": "<cookie>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Cookie: '<cookie>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cloud_provider: '<string>',
custom_network_id: '<string>',
region: '<string>',
requestParams: {
enableEnterpriseModule: true,
enableTLS: true,
falkordbPassword: '<string>',
falkordbUser: '<string>',
nodeInstanceType: '<string>',
AOFPersistenceConfig: '<string>',
description: '<string>',
falkorDBCacheSize: 123,
falkorDBMaxQueuedQueries: 123,
falkorDBNodeCreationBuffer: 123,
falkorDBQueryMemCapacity: 123,
falkorDBResultSetSize: 123,
falkorDBTimeoutDefault: 123,
falkorDBTimeoutMax: 123,
maxMemory: '<string>',
name: '<string>',
RDBPersistenceConfig: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cloud_provider' => '<string>',
'custom_network_id' => '<string>',
'region' => '<string>',
'requestParams' => [
'enableEnterpriseModule' => true,
'enableTLS' => true,
'falkordbPassword' => '<string>',
'falkordbUser' => '<string>',
'nodeInstanceType' => '<string>',
'AOFPersistenceConfig' => '<string>',
'description' => '<string>',
'falkorDBCacheSize' => 123,
'falkorDBMaxQueuedQueries' => 123,
'falkorDBNodeCreationBuffer' => 123,
'falkorDBQueryMemCapacity' => 123,
'falkorDBResultSetSize' => 123,
'falkorDBTimeoutDefault' => 123,
'falkorDBTimeoutMax' => 123,
'maxMemory' => '<string>',
'name' => '<string>',
'RDBPersistenceConfig' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <cookie>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone"
payload := strings.NewReader("{\n \"cloud_provider\": \"<string>\",\n \"custom_network_id\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"enableEnterpriseModule\": true,\n \"enableTLS\": true,\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"AOFPersistenceConfig\": \"<string>\",\n \"description\": \"<string>\",\n \"falkorDBCacheSize\": 123,\n \"falkorDBMaxQueuedQueries\": 123,\n \"falkorDBNodeCreationBuffer\": 123,\n \"falkorDBQueryMemCapacity\": 123,\n \"falkorDBResultSetSize\": 123,\n \"falkorDBTimeoutDefault\": 123,\n \"falkorDBTimeoutMax\": 123,\n \"maxMemory\": \"<string>\",\n \"name\": \"<string>\",\n \"RDBPersistenceConfig\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<cookie>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloud_provider\": \"<string>\",\n \"custom_network_id\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"enableEnterpriseModule\": true,\n \"enableTLS\": true,\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"AOFPersistenceConfig\": \"<string>\",\n \"description\": \"<string>\",\n \"falkorDBCacheSize\": 123,\n \"falkorDBMaxQueuedQueries\": 123,\n \"falkorDBNodeCreationBuffer\": 123,\n \"falkorDBQueryMemCapacity\": 123,\n \"falkorDBResultSetSize\": 123,\n \"falkorDBTimeoutDefault\": 123,\n \"falkorDBTimeoutMax\": 123,\n \"maxMemory\": \"<string>\",\n \"name\": \"<string>\",\n \"RDBPersistenceConfig\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Single-Zone")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cloud_provider\": \"<string>\",\n \"custom_network_id\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"enableEnterpriseModule\": true,\n \"enableTLS\": true,\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"AOFPersistenceConfig\": \"<string>\",\n \"description\": \"<string>\",\n \"falkorDBCacheSize\": 123,\n \"falkorDBMaxQueuedQueries\": 123,\n \"falkorDBNodeCreationBuffer\": 123,\n \"falkorDBQueryMemCapacity\": 123,\n \"falkorDBResultSetSize\": 123,\n \"falkorDBTimeoutDefault\": 123,\n \"falkorDBTimeoutMax\": 123,\n \"maxMemory\": \"<string>\",\n \"name\": \"<string>\",\n \"RDBPersistenceConfig\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Provisions a new Enterprise Cluster (Single-Zone) instance in the requested cloud provider and region. The instance is created asynchronously; poll Describe until
status is RUNNING.
Authorization
string
required
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
ID of the custom network to provision the instance in.
string
required
Region to provision the instance in, for example
us-east-1.object
required
Instance configuration.
Show requestParams properties
Show requestParams properties
boolean
default:false
required
Enable the FalkorDB enterprise module. Set at creation only.
boolean
default:false
required
Enable TLS for database connections. Set at creation only.
string
required
Default password for the database. Updating this value after deployment restarts the instance.
string
default:"falkordb"
required
Default username for the database. Set at creation only.
string
default:"e2-custom-4-8192"
required
Compute instance type used for each node. See Instance configuration.
string
default:"everysec"
Append-only file persistence mode. One of
everysec or always. Set at creation only.string
default:"Description"
Description of the instance.
number
default:25
Number of cached query executions. Between
1 and 256. Set at creation only. Maps to CACHE_SIZE in the FalkorDB configuration.number
default:50
Maximum number of queries that can be queued. Between
1 and 512. Set at creation only. Maps to MAX_QUEUED_QUERIES in the FalkorDB configuration.number
default:16384
Node creation buffer size. Between
256 and 32768. Set at creation only. Maps to NODE_CREATION_BUFFER in the FalkorDB configuration.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 in the FalkorDB configuration.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 in the FalkorDB configuration.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 in the FalkorDB configuration.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 in the FalkorDB configuration.string
default:"6GB"
Maximum memory available to the database, for example
6GB. Do not exceed the memory of the selected instance type.string
default:"My favorite database"
Human-readable name for the instance.
string
default:"low"
How often the RDB snapshot is written to disk. One of
low, medium, or high. Set at creation only.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.
See Instance configuration for the full field reference.
Response
string
ID of the resource instance.
202 Accepted
{
"id": "instance-abc123"
}
Errors
See Error for the shared error response shape.⌘I