Quickstart

This guide takes you from credentials to a running FalkorDB instance using the API.

Prerequisites

Before you begin, you need:

A FalkorDB Cloud account.
curl and jq installed locally.

Get started

Sign in with your FalkorDB Cloud email and password. The response sets the omnistrate_token session cookie that authorizes every other request, so store it in a cookie jar.

curl -s -c cookies.txt -X POST \
  https://app.falkordb.cloud/api/signin \
  -H "Content-Type: application/json" \
  -d '{"email": "'"$FALKORDB_EMAIL"'", "password": "'"$FALKORDB_PASSWORD"'"}'

The cookies are scoped to .falkordb.cloud, so curl does not replay them to https://api.omnistrate.cloud. Read the token out of the cookie jar and send it as an explicit Cookie header on the requests below.

TOKEN=$(awk '$6 == "omnistrate_token" { print $7 }' cookies.txt)

See Sign in for the full reference. The session lasts 1 hour.

Create an instance

Send a create request to the endpoint for your service tier and deployment component, passing the session token. This example creates a Free instance.

INSTANCE_ID=$(curl -s -X 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" \
  -H "Cookie: omnistrate_token=$TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "cloud_provider": "aws",
    "region": "us-east-1",
    "requestParams": {
      "name": "my-first-graph",
      "falkordbUser": "falkordb",
      "falkordbPassword": "'"$FALKORDB_DB_PASSWORD"'"
    }
  }' | jq -r .id)

Wait until it is running

Instances are provisioned asynchronously. Poll the describe endpoint until status is RUNNING.

curl -s \
  "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/$INSTANCE_ID" \
  -H "Cookie: omnistrate_token=$TOKEN" \
  | jq '{status, result_params}'

The result_params object contains the hostname and port you connect to.

Connect

Use the returned endpoint with any FalkorDB client.

redis-cli -h <hostname> -p <port> --user falkordb --pass "$FALKORDB_DB_PASSWORD" \
  GRAPH.QUERY social "CREATE (:Person {name: 'Alice'})"

Never hardcode credentials in scripts or commit them to source control. Read them from environment variables or a secret manager, and keep cookies.txt out of version control.

Next steps

Browse the API reference for every tier and component.
Review the shared schemas for request and response shapes.

Need help? Reach out at contact@falkordb.com.

Getting Started

Service tiers

Operations

Prerequisites

Get started

Next steps

​Prerequisites

​Get started

​Next steps

Prerequisites

Get started

Next steps