Create custom network
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloudProviderName": "<string>",
"cloudProviderRegion": "<string>",
"cidr": "<string>",
"name": "<string>",
"networkFeaturesConfiguration": {
"isPrivateLinkEnabled": true
},
"orgId": "<string>"
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network"
payload = {
"cloudProviderName": "<string>",
"cloudProviderRegion": "<string>",
"cidr": "<string>",
"name": "<string>",
"networkFeaturesConfiguration": { "isPrivateLinkEnabled": True },
"orgId": "<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({
cloudProviderName: '<string>',
cloudProviderRegion: '<string>',
cidr: '<string>',
name: '<string>',
networkFeaturesConfiguration: {isPrivateLinkEnabled: true},
orgId: '<string>'
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network', 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/custom-network",
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([
'cloudProviderName' => '<string>',
'cloudProviderRegion' => '<string>',
'cidr' => '<string>',
'name' => '<string>',
'networkFeaturesConfiguration' => [
'isPrivateLinkEnabled' => true
],
'orgId' => '<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/custom-network"
payload := strings.NewReader("{\n \"cloudProviderName\": \"<string>\",\n \"cloudProviderRegion\": \"<string>\",\n \"cidr\": \"<string>\",\n \"name\": \"<string>\",\n \"networkFeaturesConfiguration\": {\n \"isPrivateLinkEnabled\": true\n },\n \"orgId\": \"<string>\"\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/custom-network")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloudProviderName\": \"<string>\",\n \"cloudProviderRegion\": \"<string>\",\n \"cidr\": \"<string>\",\n \"name\": \"<string>\",\n \"networkFeaturesConfiguration\": {\n \"isPrivateLinkEnabled\": true\n },\n \"orgId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network")
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 \"cloudProviderName\": \"<string>\",\n \"cloudProviderRegion\": \"<string>\",\n \"cidr\": \"<string>\",\n \"name\": \"<string>\",\n \"networkFeaturesConfiguration\": {\n \"isPrivateLinkEnabled\": true\n },\n \"orgId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCustom networks
Create custom network
Reserve a CIDR block for a custom network in a cloud provider region.
POST
/
2022-09-01-00
/
resource-instance
/
custom-network
Create custom network
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloudProviderName": "<string>",
"cloudProviderRegion": "<string>",
"cidr": "<string>",
"name": "<string>",
"networkFeaturesConfiguration": {
"isPrivateLinkEnabled": true
},
"orgId": "<string>"
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network"
payload = {
"cloudProviderName": "<string>",
"cloudProviderRegion": "<string>",
"cidr": "<string>",
"name": "<string>",
"networkFeaturesConfiguration": { "isPrivateLinkEnabled": True },
"orgId": "<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({
cloudProviderName: '<string>',
cloudProviderRegion: '<string>',
cidr: '<string>',
name: '<string>',
networkFeaturesConfiguration: {isPrivateLinkEnabled: true},
orgId: '<string>'
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network', 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/custom-network",
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([
'cloudProviderName' => '<string>',
'cloudProviderRegion' => '<string>',
'cidr' => '<string>',
'name' => '<string>',
'networkFeaturesConfiguration' => [
'isPrivateLinkEnabled' => true
],
'orgId' => '<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/custom-network"
payload := strings.NewReader("{\n \"cloudProviderName\": \"<string>\",\n \"cloudProviderRegion\": \"<string>\",\n \"cidr\": \"<string>\",\n \"name\": \"<string>\",\n \"networkFeaturesConfiguration\": {\n \"isPrivateLinkEnabled\": true\n },\n \"orgId\": \"<string>\"\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/custom-network")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloudProviderName\": \"<string>\",\n \"cloudProviderRegion\": \"<string>\",\n \"cidr\": \"<string>\",\n \"name\": \"<string>\",\n \"networkFeaturesConfiguration\": {\n \"isPrivateLinkEnabled\": true\n },\n \"orgId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/custom-network")
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 \"cloudProviderName\": \"<string>\",\n \"cloudProviderRegion\": \"<string>\",\n \"cidr\": \"<string>\",\n \"name\": \"<string>\",\n \"networkFeaturesConfiguration\": {\n \"isPrivateLinkEnabled\": true\n },\n \"orgId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCreates a custom network. FalkorDB provisions the underlying VPC or VNet in the requested region using the CIDR block you reserve. Once the network reaches
READY, pass its ID as custom_network_id when creating an Enterprise deployment instance.
VPC peering is not available through the API. After the network is
READY, open a support ticket at support.falkordb.com or email [email protected] to request peering with your own VPC. Choose a CIDR block that does not overlap with the networks you plan to peer.Authorization
Body
string
required
Cloud provider to create the network in, for example
aws or gcp.string
required
Region to create the network in, for example
us-east-1.string
required
CIDR block for the network, for example
10.0.0.0/16.string
Friendly name to distinguish networks that share a CIDR.
string
ID of the organization that owns the custom network. Defaults to your organization.
Request
{
"cloudProviderName": "aws",
"cloudProviderRegion": "us-east-1",
"cidr": "10.0.0.0/16",
"name": "prod-vpc"
}
Response
Returns the created custom network. See Describe custom network for the field list.Errors
See Error for the error response shape.⌘I