Skip to main content
GET
Describe account configuration
Returns the account configuration, including the CloudFormation template URL or bootstrap shell command you run in your cloud account to grant FalkorDB the permissions it needs.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>.

Path parameters

string
required
Account configuration ID. Read it from result_params.cloud_provider_account_config_id on the cloud account deployment instance.

Response

string
required
ID of the account configuration.
string
required
Name of the account configuration.
string
required
Description of the account configuration.
string
required
ID of the cloud provider.
string
required
Configuration status: PENDING, VERIFYING, READY, FAILED, or READY_TO_OFFBOARD.
string
required
Human readable detail for the current status.
string[]
BYOA deployment instances tied to this account configuration.

AWS

string
Your AWS account ID.
string
Bootstrap role ARN FalkorDB assumes.
string
CloudFormation template to deploy in your AWS account.
string
CloudFormation template variant without a load balancer.

GCP

string
Your GCP project ID.
string
Your GCP project number.
string
Bootstrap service account email.
string
Command to run in Cloud Shell to grant permissions.
string
Command to revoke access without offboarding.
string
Command to remove all FalkorDB resources from the project.

Azure

string
Your Azure subscription ID.
string
Your Azure tenant ID.
string
Command to run in Azure Cloud Shell to grant permissions.
string
Command to revoke access without offboarding.
string
Command to remove all FalkorDB resources from the subscription.

OCI

string
Your OCI tenancy OCID.
string
Your OCI identity domain OCID.
string
Command to run in OCI Cloud Shell to grant permissions.
string
Command to revoke access without offboarding.
string
Command to remove all FalkorDB resources from the tenancy.
Run the offboard command only after deleting every BYOA deployment instance in the account. It removes the FalkorDB infrastructure from your cloud account.

Errors

See Error for the error response shape.