Getting Started

Client Library Reference

Tools Reference

getting-started

Getting Started

Web app tutorials

Mobile tutorials

functions

Examples

realtime

Channels

Postgres Changes

storage

Image Transformations

platform

Add-ons

Compute Add-ons

Platform Management

Migrating and Upgrading

Network Restrictions

Performance Tuning

Single sign-on

Enable SSO for your organization

SSO with Azure AD

SSO with Google Workspace

Go-live Checklist

Production Readiness

resources

Migrate to Supabase

Firebase Storage

Supabase CLI

Local Development

Managing Environments

Self-Hosting

Self-Hosting Reference

Realtime Server

integrations

Auth

Caching / Offline-first

Developer Tools

Low-code

reference

Client libraries

Other tools

Back to Main Menu

reference_javascript_v1

javascript

Typescript Support

Database

Call a Postgres function

Using Modifiers

Auth

Create a new user

Sign out a user

Retrieve a session

Update the access token

Retrieve a user

Retrieve a session

Retrieve a user

Listen to auth events

Send a password reset request

Auth Admin

Send an email invite link

Send a password reset request

Generate an email link

Send a one-time passcode

Functions

Invoke a function

Realtime

Subscribe to database changes

Remove a subscription

Remove all subscriptions

Retrieve subscriptions

Storage

Create a bucket

Retrieve a bucket

List all buckets

Update a bucket

Delete a bucket

Download a file

List all files in a bucket

Replace an existing file

Move an existing file

Copy an existing file

Delete files in a bucket

Create a signed URL

Create signed URLs

Retrieve public URL

Misc

Back to Main Menu

reference_javascript_v2

javascript

Typescript Support

Database

Call a Postgres function

Using Modifiers

Auth

Create a new user

Sign in a user through OTP

Sign in a user through OAuth

Sign out a user

Verify and log in through OTP

Retrieve a session

Retrieve a new session

Retrieve a user

Set the session data

Listen to auth events

Send a password reset request

Enroll a factor

Create a challenge

Verify a challenge

Create and verify a challenge

Unenroll a factor

Get Authenticator Assurance Level

Auth Admin

Retrieve a user

Send an email invite link

Send a password reset request

Generate an email link

List all factors for a user

Delete a factor for a user

Functions

Invoke a function

Realtime

Subscribe to database changes

Unsubscribe from a channel

Unsubscribe from all channels

Retrieve all channels

Storage

Create a bucket

Retrieve a bucket

List all buckets

Update a bucket

Delete a bucket

Download a file

List all files in a bucket

Replace an existing file

Move an existing file

Copy an existing file

Delete files in a bucket

Create a signed URL

Create signed URLs

Retrieve public URL

Misc

Back to Main Menu

reference_dart_v0

dart

Back to Main Menu

reference_cli

Supabase CLI

general

supabase test db

supabase status

supabase gen types

supabase gen types typescript

Database

supabase db reset

supabase db remote

supabase db remote commit

supabase db push

supabase db lint

supabase db diff

migrations

supabase migration

supabase migration new

supabase migration list

supabase migration repair

secrets

supabase secrets

supabase secrets unset

supabase secrets set

supabase secrets list

projects

supabase projects

supabase projects list

supabase projects create

organizations

supabase orgs list

Edge Functions

supabase functions

supabase functions serve

supabase functions new

supabase functions deploy

supabase functions delete

Domains

supabase domains

supabase domains reverify

supabase domains get

supabase domains delete

supabase domains create

supabase domains activate

Vanity Subdomains

supabase vanity-subdomains

supabase vanity-subdomains check-availability

supabase vanity-subdomains activate

supabase vanity-subdomains delete

supabase vanity-subdomains get

Network Restrictions

supabase network-restrictions

supabase network-restrictions get

supabase network-restrictions update

Completion

supabase completion

supabase completion zsh

supabase completion powershell

supabase completion fish

supabase completion bash

Back to Main Menu

reference_self_hosting_auth

Self-Hosting Auth

Usage

Generates an email action link

Returns the created user

Redirects the user to the 3rd party oauth provider to start the oauth1 0 or oauth2 0 authentication process

Receives the redirect from an external provider during the oauth authentication process starts the process of creating an access and refresh token

The healthcheck endpoint for gotrue returns the current gotrue version

Sends an invite link to the user

Logs out the user

Passwordless sign in method for email or phone

Sends a password recovery email link to the users email

Returns the configuration settings for the gotrue server

Password based signup with either email or phone

Signs in a user with a password

Refreshes a users refresh token

Get information for the logged in user

Returns the updated user

Verifies a sign up

Verifies a sign up

Back to Main Menu

reference_self_hosting_realtime

Self-Hosting Realtime

Home

Getting Started

Client Library Reference

Tools Reference

getting-started

Getting Started

Web app tutorials

Mobile tutorials

functions

Examples

realtime

Channels

Postgres Changes

storage

Image Transformations

platform

Add-ons

Compute Add-ons

Platform Management

Migrating and Upgrading

Network Restrictions

Performance Tuning

Single sign-on

Enable SSO for your organization

SSO with Azure AD

SSO with Google Workspace

Go-live Checklist

Production Readiness

resources

Migrate to Supabase

Firebase Storage

Supabase CLI

Local Development

Managing Environments

Self-Hosting

Self-Hosting Reference

Realtime Server

integrations

Auth

Caching / Offline-first

Developer Tools

Low-code

reference

Client libraries

Other tools

Back to Main Menu

reference_javascript_v1

javascript

Typescript Support

Database

Call a Postgres function

Using Modifiers

Auth

Create a new user

Sign out a user

Retrieve a session

Update the access token

Retrieve a user

Retrieve a session

Retrieve a user

Listen to auth events

Send a password reset request

Auth Admin

Send an email invite link

Send a password reset request

Generate an email link

Send a one-time passcode

Functions

Invoke a function

Realtime

Subscribe to database changes

Remove a subscription

Remove all subscriptions

Retrieve subscriptions

Storage

Create a bucket

Retrieve a bucket

List all buckets

Update a bucket

Delete a bucket

Download a file

List all files in a bucket

Replace an existing file

Move an existing file

Copy an existing file

Delete files in a bucket

Create a signed URL

Create signed URLs

Retrieve public URL

Misc

Back to Main Menu

reference_javascript_v2

javascript

Typescript Support

Database

Call a Postgres function

Using Modifiers

Auth

Create a new user

Sign in a user through OTP

Sign in a user through OAuth

Sign out a user

Verify and log in through OTP

Retrieve a session

Retrieve a new session

Retrieve a user

Set the session data

Listen to auth events

Send a password reset request

Enroll a factor

Create a challenge

Verify a challenge

Create and verify a challenge

Unenroll a factor

Get Authenticator Assurance Level

Auth Admin

Retrieve a user

Send an email invite link

Send a password reset request

Generate an email link

List all factors for a user

Delete a factor for a user

Functions

Invoke a function

Realtime

Subscribe to database changes

Unsubscribe from a channel

Unsubscribe from all channels

Retrieve all channels

Storage

Create a bucket

Retrieve a bucket

List all buckets

Update a bucket

Delete a bucket

Download a file

List all files in a bucket

Replace an existing file

Move an existing file

Copy an existing file

Delete files in a bucket

Create a signed URL

Create signed URLs

Retrieve public URL

Misc

Back to Main Menu

reference_dart_v0

dart

Back to Main Menu

reference_cli

Supabase CLI

general

supabase test db

supabase status

supabase gen types

supabase gen types typescript

Database

supabase db reset

supabase db remote

supabase db remote commit

supabase db push

supabase db lint

supabase db diff

migrations

supabase migration

supabase migration new

supabase migration list

supabase migration repair

secrets

supabase secrets

supabase secrets unset

supabase secrets set

supabase secrets list

projects

supabase projects

supabase projects list

supabase projects create

organizations

supabase orgs list

Edge Functions

supabase functions

supabase functions serve

supabase functions new

supabase functions deploy

supabase functions delete

Domains

supabase domains

supabase domains reverify

supabase domains get

supabase domains delete

supabase domains create

supabase domains activate

Vanity Subdomains

supabase vanity-subdomains

supabase vanity-subdomains check-availability

supabase vanity-subdomains activate

supabase vanity-subdomains delete

supabase vanity-subdomains get

Network Restrictions

supabase network-restrictions

supabase network-restrictions get

supabase network-restrictions update

Completion

supabase completion

supabase completion zsh

supabase completion powershell

supabase completion fish

supabase completion bash

Back to Main Menu

reference_self_hosting_auth

Self-Hosting Auth

Usage

Generates an email action link

Returns the created user

Redirects the user to the 3rd party oauth provider to start the oauth1 0 or oauth2 0 authentication process

Receives the redirect from an external provider during the oauth authentication process starts the process of creating an access and refresh token

The healthcheck endpoint for gotrue returns the current gotrue version

Sends an invite link to the user

Logs out the user

Passwordless sign in method for email or phone

Sends a password recovery email link to the users email

Returns the configuration settings for the gotrue server

Password based signup with either email or phone

Signs in a user with a password

Refreshes a users refresh token

Get information for the logged in user

Returns the updated user

Verifies a sign up

Verifies a sign up

Back to Main Menu

reference_self_hosting_realtime

Self-Hosting Realtime

Resources

Glossary

Definitions for terminology and acronyms used in the Supabase documentation.

Migrate to Supabase#

Firebase Auth

Move your auth users from a Firebase project to a Supabase project.Learn more

Firestore Data

Migrate the contents of a Firestore collection to a single PostgreSQL table.Learn more

Firebase Storage

Convert your Firebase Storage files to Supabase Storage.Learn more

Heroku

Migrate your Heroku Postgres database to Supabase.Learn more

Supabase CLI#

Develop your project locally, manage your Supabase projects, handle database migrations, CI/CD workflows, and generate types from your database schema, all from the comfort of your Terminal.

Self-Hosting Supabase#

We're happy to host your next big thing, but we also make it easy to host Supabase on your own. We use Docker to help make setup as painless as possible.

Need some help?

Not to worry, our specialist engineers are here to help. Submit a support ticket through the Dashboard.

Supabase 2022—Contributing Changelog Author Styleguide Open Source SupaSquad