Create cloud account
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{serviceModelKey}/{productTierKey}/{resourceKey} \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloud_provider": "<string>",
"requestParams": {
"cloud_provider": "<string>",
"aws_account_id": "<string>",
"aws_bootstrap_role_arn": "<string>",
"account_configuration_method": "<string>",
"private_link": "<string>",
"gcp_project_id": "<string>",
"gcp_project_number": "<string>",
"gcp_service_account_email": "<string>",
"azure_subscription_id": "<string>",
"azure_tenant_id": "<string>",
"oci_tenancy_id": "<string>",
"oci_domain_id": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{serviceModelKey}/{productTierKey}/{resourceKey}"
payload = {
"cloud_provider": "<string>",
"requestParams": {
"cloud_provider": "<string>",
"aws_account_id": "<string>",
"aws_bootstrap_role_arn": "<string>",
"account_configuration_method": "<string>",
"private_link": "<string>",
"gcp_project_id": "<string>",
"gcp_project_number": "<string>",
"gcp_service_account_email": "<string>",
"azure_subscription_id": "<string>",
"azure_tenant_id": "<string>",
"oci_tenancy_id": "<string>",
"oci_domain_id": "<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>',
requestParams: {
cloud_provider: '<string>',
aws_account_id: '<string>',
aws_bootstrap_role_arn: '<string>',
account_configuration_method: '<string>',
private_link: '<string>',
gcp_project_id: '<string>',
gcp_project_number: '<string>',
gcp_service_account_email: '<string>',
azure_subscription_id: '<string>',
azure_tenant_id: '<string>',
oci_tenancy_id: '<string>',
oci_domain_id: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{serviceModelKey}/{productTierKey}/{resourceKey}', 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/{serviceModelKey}/{productTierKey}/{resourceKey}",
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>',
'requestParams' => [
'cloud_provider' => '<string>',
'aws_account_id' => '<string>',
'aws_bootstrap_role_arn' => '<string>',
'account_configuration_method' => '<string>',
'private_link' => '<string>',
'gcp_project_id' => '<string>',
'gcp_project_number' => '<string>',
'gcp_service_account_email' => '<string>',
'azure_subscription_id' => '<string>',
'azure_tenant_id' => '<string>',
'oci_tenancy_id' => '<string>',
'oci_domain_id' => '<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/{serviceModelKey}/{productTierKey}/{resourceKey}"
payload := strings.NewReader("{\n \"cloud_provider\": \"<string>\",\n \"requestParams\": {\n \"cloud_provider\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"aws_bootstrap_role_arn\": \"<string>\",\n \"account_configuration_method\": \"<string>\",\n \"private_link\": \"<string>\",\n \"gcp_project_id\": \"<string>\",\n \"gcp_project_number\": \"<string>\",\n \"gcp_service_account_email\": \"<string>\",\n \"azure_subscription_id\": \"<string>\",\n \"azure_tenant_id\": \"<string>\",\n \"oci_tenancy_id\": \"<string>\",\n \"oci_domain_id\": \"<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/{serviceModelKey}/{productTierKey}/{resourceKey}")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloud_provider\": \"<string>\",\n \"requestParams\": {\n \"cloud_provider\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"aws_bootstrap_role_arn\": \"<string>\",\n \"account_configuration_method\": \"<string>\",\n \"private_link\": \"<string>\",\n \"gcp_project_id\": \"<string>\",\n \"gcp_project_number\": \"<string>\",\n \"gcp_service_account_email\": \"<string>\",\n \"azure_subscription_id\": \"<string>\",\n \"azure_tenant_id\": \"<string>\",\n \"oci_tenancy_id\": \"<string>\",\n \"oci_domain_id\": \"<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/{serviceModelKey}/{productTierKey}/{resourceKey}")
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 \"requestParams\": {\n \"cloud_provider\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"aws_bootstrap_role_arn\": \"<string>\",\n \"account_configuration_method\": \"<string>\",\n \"private_link\": \"<string>\",\n \"gcp_project_id\": \"<string>\",\n \"gcp_project_number\": \"<string>\",\n \"gcp_service_account_email\": \"<string>\",\n \"azure_subscription_id\": \"<string>\",\n \"azure_tenant_id\": \"<string>\",\n \"oci_tenancy_id\": \"<string>\",\n \"oci_domain_id\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Cloud accounts
Create cloud account
Register your own cloud account for Enterprise BYOA deployments.
POST
/
2022-09-01-00
/
resource-instance
/
sp-JvkxkPhinN
/
falkordb
/
v1
/
prod
/
{serviceModelKey}
/
{productTierKey}
/
{resourceKey}
Create cloud account
curl --request POST \
--url https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{serviceModelKey}/{productTierKey}/{resourceKey} \
--header 'Content-Type: application/json' \
--header 'Cookie: <cookie>' \
--data '
{
"cloud_provider": "<string>",
"requestParams": {
"cloud_provider": "<string>",
"aws_account_id": "<string>",
"aws_bootstrap_role_arn": "<string>",
"account_configuration_method": "<string>",
"private_link": "<string>",
"gcp_project_id": "<string>",
"gcp_project_number": "<string>",
"gcp_service_account_email": "<string>",
"azure_subscription_id": "<string>",
"azure_tenant_id": "<string>",
"oci_tenancy_id": "<string>",
"oci_domain_id": "<string>"
}
}
'import requests
url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{serviceModelKey}/{productTierKey}/{resourceKey}"
payload = {
"cloud_provider": "<string>",
"requestParams": {
"cloud_provider": "<string>",
"aws_account_id": "<string>",
"aws_bootstrap_role_arn": "<string>",
"account_configuration_method": "<string>",
"private_link": "<string>",
"gcp_project_id": "<string>",
"gcp_project_number": "<string>",
"gcp_service_account_email": "<string>",
"azure_subscription_id": "<string>",
"azure_tenant_id": "<string>",
"oci_tenancy_id": "<string>",
"oci_domain_id": "<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>',
requestParams: {
cloud_provider: '<string>',
aws_account_id: '<string>',
aws_bootstrap_role_arn: '<string>',
account_configuration_method: '<string>',
private_link: '<string>',
gcp_project_id: '<string>',
gcp_project_number: '<string>',
gcp_service_account_email: '<string>',
azure_subscription_id: '<string>',
azure_tenant_id: '<string>',
oci_tenancy_id: '<string>',
oci_domain_id: '<string>'
}
})
};
fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{serviceModelKey}/{productTierKey}/{resourceKey}', 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/{serviceModelKey}/{productTierKey}/{resourceKey}",
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>',
'requestParams' => [
'cloud_provider' => '<string>',
'aws_account_id' => '<string>',
'aws_bootstrap_role_arn' => '<string>',
'account_configuration_method' => '<string>',
'private_link' => '<string>',
'gcp_project_id' => '<string>',
'gcp_project_number' => '<string>',
'gcp_service_account_email' => '<string>',
'azure_subscription_id' => '<string>',
'azure_tenant_id' => '<string>',
'oci_tenancy_id' => '<string>',
'oci_domain_id' => '<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/{serviceModelKey}/{productTierKey}/{resourceKey}"
payload := strings.NewReader("{\n \"cloud_provider\": \"<string>\",\n \"requestParams\": {\n \"cloud_provider\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"aws_bootstrap_role_arn\": \"<string>\",\n \"account_configuration_method\": \"<string>\",\n \"private_link\": \"<string>\",\n \"gcp_project_id\": \"<string>\",\n \"gcp_project_number\": \"<string>\",\n \"gcp_service_account_email\": \"<string>\",\n \"azure_subscription_id\": \"<string>\",\n \"azure_tenant_id\": \"<string>\",\n \"oci_tenancy_id\": \"<string>\",\n \"oci_domain_id\": \"<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/{serviceModelKey}/{productTierKey}/{resourceKey}")
.header("Cookie", "<cookie>")
.header("Content-Type", "application/json")
.body("{\n \"cloud_provider\": \"<string>\",\n \"requestParams\": {\n \"cloud_provider\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"aws_bootstrap_role_arn\": \"<string>\",\n \"account_configuration_method\": \"<string>\",\n \"private_link\": \"<string>\",\n \"gcp_project_id\": \"<string>\",\n \"gcp_project_number\": \"<string>\",\n \"gcp_service_account_email\": \"<string>\",\n \"azure_subscription_id\": \"<string>\",\n \"azure_tenant_id\": \"<string>\",\n \"oci_tenancy_id\": \"<string>\",\n \"oci_domain_id\": \"<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/{serviceModelKey}/{productTierKey}/{resourceKey}")
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 \"requestParams\": {\n \"cloud_provider\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"aws_bootstrap_role_arn\": \"<string>\",\n \"account_configuration_method\": \"<string>\",\n \"private_link\": \"<string>\",\n \"gcp_project_id\": \"<string>\",\n \"gcp_project_number\": \"<string>\",\n \"gcp_service_account_email\": \"<string>\",\n \"azure_subscription_id\": \"<string>\",\n \"azure_tenant_id\": \"<string>\",\n \"oci_tenancy_id\": \"<string>\",\n \"oci_domain_id\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Registers a cloud account by creating a deployment instance of the account configuration resource in a BYOA service plan.
Once created, describe the instance to read
Finding the resource key
resourceKey is the urlKey of the offering resource whose resourceId starts with r-injectedaccountconfig. Read it from List service plans:
{
"resourceParameters": [
{ "resourceId": "r-injectedaccountconfig-abc", "urlKey": "account-config", "name": "Account Config" }
]
}
serviceModelKey and productTierKey come from the same service plan entry.
Authorization
Path parameters
string
required
Service model key of the BYOA plan, for example
byoa.string
required
Product tier key of the BYOA plan.
string
required
URL key of the account configuration resource.
Query parameters
string
required
Subscription to the BYOA product tier.
Body
string
required
Cloud provider:
aws, gcp, azure, or oci.object
required
Provider-specific parameters.
Show AWS
Show AWS
Show GCP
Show GCP
Show Azure
Show Azure
AWS request
{
"cloud_provider": "aws",
"requestParams": {
"cloud_provider": "aws",
"aws_account_id": "123456789012",
"aws_bootstrap_role_arn": "arn:aws:iam::123456789012:role/omnistrate-bootstrap-role",
"account_configuration_method": "CloudFormation",
"allow_new_cloud_native_network_creation": true
}
}
GCP request
{
"cloud_provider": "gcp",
"requestParams": {
"gcp_project_id": "my-project",
"gcp_project_number": "123456789012",
"gcp_service_account_email": "[email protected]",
"account_configuration_method": "GCPScript",
"allow_new_cloud_native_network_creation": true
}
}
Response
string
ID of the cloud account deployment instance. Use it to delete the cloud account.
result_params.cloud_provider_account_config_id, then call Describe account configuration to get the bootstrap instructions.
Errors
See Error for the error response shape.⌘I