Go to Cloud
Cloud
Go to Cloud

Usage ​

Learn how to register your database and make API requests with Electric Cloud.

Register your Database ​

  1. Go to Electric Cloud and log in.

  2. Add a new database by clicking on New Source.

  3. Pick a region, team, and fill in your PostgreSQL connection string. Click the connect source button to connect your database to Electric Cloud.

Once connected you should see your source details.

Source details in cloud dashboard

Making API Requests ​

To request a shape you need to make an API request to https://api.electric-sql.cloud/v1/shape. Don't forget to include the source credentials you obtained in the previous step.

Here is an example request using curl:

shell
export SOURCE_ID="8ea4e5fb-9217-4ca6-80b7-0a97581c4c10"
export SECRET="<long secret value>"

export SHAPE_DEFINITION="table=items&offset=-1"

curl -i "https://api.electric-sql.cloud/v1/shape?$SHAPE_DEFINITION\
    &source_id=$SOURCE_ID\
    &secret=$SECRET"

Security Model ​

The source ID is a key that uniquely identifies your Postgres database. The source secret is a token that grants access to it.

Do not use your source secret in the client!

If you use the source secret from a client, then this exposes it to malicious users.

See the security guide for more context.

Proxy Auth ​

The recommended pattern is to add the source ID and secret parameter to the origin request made by your auth proxy or API.

See the Cloud overview for detailed examples.