Create instance
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloud_provider": "<string>",
"region": "<string>",
"requestParams": {
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"description": "<string>",
"name": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free"
payload = {
"cloud_provider": "<string>",
"region": "<string>",
"requestParams": {
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"description": "<string>",
"name": "<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>',
region: '<string>',
requestParams: {
falkordbPassword: '<string>',
falkordbUser: '<string>',
description: '<string>',
name: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free', 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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free",
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>',
'region' => '<string>',
'requestParams' => [
'falkordbPassword' => '<string>',
'falkordbUser' => '<string>',
'description' => '<string>',
'name' => '<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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free"
payload := strings.NewReader("{\n \"cloud_provider\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloud_provider\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free")
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 \"region\": \"<string>\",\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Free
Create instance
Provision a new Free instance.
POST
/
2022-09-01-00
/
resource-instance
/
sp-JvkxkPhinN
/
falkordb
/
v1
/
prod
/
falkordb-free-customer-hosted
/
falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy
/
free
Create instance
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloud_provider": "<string>",
"region": "<string>",
"requestParams": {
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"description": "<string>",
"name": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free"
payload = {
"cloud_provider": "<string>",
"region": "<string>",
"requestParams": {
"falkordbPassword": "<string>",
"falkordbUser": "<string>",
"description": "<string>",
"name": "<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>',
region: '<string>',
requestParams: {
falkordbPassword: '<string>',
falkordbUser: '<string>',
description: '<string>',
name: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free', 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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free",
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>',
'region' => '<string>',
'requestParams' => [
'falkordbPassword' => '<string>',
'falkordbUser' => '<string>',
'description' => '<string>',
'name' => '<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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free"
payload := strings.NewReader("{\n \"cloud_provider\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloud_provider\": \"<string>\",\n \"region\": \"<string>\",\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<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-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free")
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 \"region\": \"<string>\",\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"falkordbUser\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Provisions a new Free 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
Region to provision the instance in, for example
us-east-1.object
required
Instance configuration.
Show requestParams properties
Show requestParams properties
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:"Description"
Description of the instance.
string
default:"FalkorDB Instance"
Human-readable name for the instance.
Sizing and tier availability
The Free tier is fixed size and does not expose any sizing parameters. Onlyname, 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
{
"id": "instance-abc123"
}
Errors
See Error for the shared error response shape.Was this page helpful?
⌘I