TypeDB 3.0 is live! Get started for free.

TypeDB Cloud

Preliminaries

Connecting to TypeDB Cloud requires:

  • A cluster deployed through TypeDB Cloud

  • The address and port of the server - these can be found on the page for your cluster

  • A valid username and password - you should have set the password for the admin user while setting up your cluster

Connecting your client

  • Console

  • Studio

Run Console in CLI:

Connect to TypeDB
typedb console --address=<server-address> --username=<username>

You will be prompted for a password.

Run Studio and follow instructions below:

  1. In the TypeDB Cloud website, navigate to your cluster and click Connect. Then, click Connect with TypeDB Studio. This will launch TypeDB Studio.

  2. Fill in your password and hit Connect. Your password can be found in your downloaded credentials file (if you have one).

Connecting your application

For programmatic access, use one of the TypeDB drivers via the network API:

  • Rust

  • Python

  • Java

  • Node.js

  • C#

  • C++

  • C

  • HTTP

let uri = format!("{}:{}", address, port);
let driver = TypeDBDriver::new(
    &uri,
    Credentials::new(username, password),
    DriverOptions::new(false, None).unwrap(),
).await;
uri = f"{address}:{port}"
driver = TypeDB.driver(uri, Credentials(username, password), DriverOptions(False, None))
uri = String.format("%s:%s", address, port)
Driver driver = TypeDB.driver(uri, new Credentials(username, password), new DriverOptions(false, null));
Coming soon.
Coming soon.
Coming soon.
Coming soon.

Send a sign in HTTP request:

curl
curl --request POST \
  --url https://{address}:{http_port}/v1/signin \
  --json '{"username": "USERNAME", "password": "PASSWORD"}'

Note that the {http_port} is different from the regular TypeDB port mentioned above and is defaulted to 8000.

A successful response will contain an authentication token:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImV4cCI6MTc0NDYzNTI5NSwiaWF0IjoxNzQ0NjIwODk1fQ.WEhmBTAXI_qZUlAB7zw52LDGJhnqfNTXS63QDSZlqds"
}

Put it in the authorization header of the future requests. See HTTP endpoint authentication for more information.