Platform

Terraform Provider reference

Resources and data sources available through the Terraform Provider


The Terraform Provider provices access to resources and data sources. Resources are infrastructure objects, such as a Supabase project, that you can declaratively configure. Data sources are sources of information about your Supabase instances.

Provider settings

Use these settings to configure your Supabase provider and authenticate to your Supabase project.

Example usage

1provider "supabase" {
2    access_token = ""
3    endpoint = ""
4}

Details

AttributeDescriptionTypeOptionalSensitive
access_token

Supabase access token

stringtruetrue
endpoint

Supabase API endpoint

stringtrue

Resources

You can configure these resources using the Supabase Terraform provider:

Example usage

1resource "supabase_branch" "<label>" {
2    git_branch = ""
3    parent_project_ref = ""
4    region = ""
5}

Details

AttributeDescriptionTypeRequiredOptionalRead-only
database

Database connection details

true
git_branch

Git branch

stringtrue
id

Branch identifier

stringtrue
parent_project_ref

Parent project ref

stringtrue
region

Database region

stringtrue

Data sources

You can read these resources using the Supabase Terraform provider:

Example usage

1resource "supabase_branch" "all" {
2    parent_project_ref = ""
3}

Details

AttributeDescriptionTypeRequiredOptionalRead-only
branches

Branch databases

true
parent_project_ref

Parent project ref

stringtrue