Update instance
curl --request PUT \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id} \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"requestParams": {
"falkordbPassword": "<string>",
"nodeInstanceType": "<string>",
"description": "<string>",
"name": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}"
payload = { "requestParams": {
"falkordbPassword": "<string>",
"nodeInstanceType": "<string>",
"description": "<string>",
"name": "<string>"
} }
headers = {
"Cookie": "<cookie>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Cookie: '<cookie>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestParams: {
falkordbPassword: '<string>',
nodeInstanceType: '<string>',
description: '<string>',
name: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}', 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-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'requestParams' => [
'falkordbPassword' => '<string>',
'nodeInstanceType' => '<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-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}"
payload := strings.NewReader("{\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"nodeInstanceType\": \"<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-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Cookie"] = '<cookie>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Multi-Zone
Update instance
Update the configuration of a Pro Multi-Zone instance.
PUT
/
2022-09-01-00
/
resource-instance
/
sp-JvkxkPhinN
/
falkordb
/
v1
/
prod
/
falkordb-pro-customer-hosted
/
falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy
/
multi-Zone
/
{id}
Update instance
curl --request PUT \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id} \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"requestParams": {
"falkordbPassword": "<string>",
"nodeInstanceType": "<string>",
"description": "<string>",
"name": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}"
payload = { "requestParams": {
"falkordbPassword": "<string>",
"nodeInstanceType": "<string>",
"description": "<string>",
"name": "<string>"
} }
headers = {
"Cookie": "<cookie>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Cookie: '<cookie>', 'Content-Type': 'application/json'},
body: JSON.stringify({
requestParams: {
falkordbPassword: '<string>',
nodeInstanceType: '<string>',
description: '<string>',
name: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}', 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-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'requestParams' => [
'falkordbPassword' => '<string>',
'nodeInstanceType' => '<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-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}"
payload := strings.NewReader("{\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"nodeInstanceType\": \"<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-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Cookie"] = '<cookie>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"requestParams\": {\n \"falkordbPassword\": \"<string>\",\n \"nodeInstanceType\": \"<string>\",\n \"description\": \"<string>\",\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Applies configuration changes to a running instance. Only the fields you send are changed. Changing
falkordbPassword or nodeInstanceType restarts the instance.
Authorization
string
required
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.
Show requestParams properties
Show requestParams properties
string
required
Default password for the database. Updating this value after deployment restarts the instance.
string
default:"e2-custom-4-8192"
required
Compute instance type used for each node. See Instance configuration.
string
default:"FalkorDB Instance"
Description of the instance.
string
default:"FalkorDB Instance"
Human-readable name for the instance.
Sizing and tier availability
nodeInstanceType is required and must be one of the instance types below. The list differs from the Enterprise tiers, which accept any instance type available to the plan.
| Cloud provider | nodeInstanceType | vCPU | Memory |
|---|---|---|---|
| AWS | t4g.medium | 2 | 4 GB |
| AWS | m7g.large | 2 | 8 GB |
| AWS | r7g.large | 2 | 16 GB |
| AWS | c7g.xlarge | 4 | 8 GB |
| AWS | m7g.xlarge | 4 | 16 GB |
| AWS | r7g.xlarge | 4 | 32 GB |
| AWS | c7g.2xlarge | 8 | 16 GB |
| AWS | m7g.2xlarge | 8 | 32 GB |
| AWS | r7g.2xlarge | 8 | 64 GB |
| AWS | c7g.4xlarge | 16 | 32 GB |
| AWS | m7g.4xlarge | 16 | 64 GB |
| AWS | r7g.4xlarge | 16 | 128 GB |
| AWS | c7g.8xlarge | 32 | 64 GB |
| AWS | m7g.8xlarge | 32 | 128 GB |
| GCP | e2-medium | 2 | 4 GB |
| GCP | e2-standard-2 | 2 | 8 GB |
| GCP | e2-highmem-2 | 2 | 16 GB |
| GCP | e2-custom-4-8192 | 4 | 8 GB |
| GCP | e2-standard-4 | 4 | 16 GB |
| GCP | e2-highmem-4 | 4 | 32 GB |
| GCP | e2-custom-8-16384 | 8 | 16 GB |
| GCP | e2-standard-8 | 8 | 32 GB |
| GCP | e2-highmem-8 | 8 | 64 GB |
| GCP | e2-custom-16-32768 | 16 | 32 GB |
| GCP | e2-custom-32-65536 | 32 | 64 GB |
maxMemory and enableEnterpriseModule are not available on the Pro tier. Memory is determined by the selected nodeInstanceType.
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.⌘I