# Supabase for Platforms Use Supabase as a platform for your own business and tools. Supabase is a [Platform as a Service](https://en.wikipedia.org/wiki/Platform_as_a_service) (PaaS) that can be managed programmatically. You can use it to offer the key primitives to your own users, such as [Database](/docs/guides/database/overview), [Auth](/docs/guides/auth), [Edge Functions](/docs/guides/functions), [Storage](/docs/guides/storage), and [Realtime](/docs/guides/realtime). Supabase is commonly used as a platform by AI Builders and frameworks needing a backend. This document will guide you on best practices when using Supabase for your own platform and assumes that Supabase projects are in a Supabase organization that you own. If you want to instead interact with projects that your users own, navigate to [OAuth integration](/docs/guides/integrations/build-a-supabase-oauth-integration) for more details. ![Platform as a Service](/docs/img/integrations/paas-intro.png) ## Overview All features of Supabase can be managed through the [Management API](/docs/reference/api/introduction) or the [remote MCP Server](/docs/guides/getting-started/mcp). ## Launching projects Management API endpoints: - Create project: [`POST /v1/projects`](https://api.supabase.com/api/v1#tag/projects/post/v1/projects) - Get smart region selection codes: [`GET /v1/projects/available-regions`](https://api.supabase.com/api/v1#tag/projects/get/v1/projects/available-regions) - Check service health: [`GET /v1/projects/{ref}/health`](https://api.supabase.com/api/v1#tag/projects/get/v1/projects/{ref}/health) We recommend: - **a _very_ secure password for each database**. Do not reuse the same password across databases. - **storing the encrypted version of the password**. Once you set the password during project creation, there is no way to programmatically change the password but you can do so manually in the Supabase Dashboard. - **using smart region selection to ensure there's enough capacity**. The available smart region codes are `americas`, `emea`, and `apac` and you can make a request to [`GET /v1/projects/available-regions`](https://api.supabase.com/api/v1#tag/projects/get/v1/projects/available-regions) for region details. - **using an appropriate instance size**. Scale to zero pricing only applies to `pico` instances, make sure to not pass in a `desired_instance_size` when creating a project. >= Micro instances are not able to scale to zero. - **make sure that the services are `ACTIVE_HEALTHY` after project creation**. After creating project, confirm the service that you want to make a request to has a status of `ACTIVE_HEALTHY` by polling [`GET /v1/projects/{ref}/health`](https://api.supabase.com/api/v1#tag/projects/get/v1/projects/{ref}/health). For example, before making a request to set an Auth configuration confirm that the Auth service has a status of `ACTIVE_HEALTHY`. ```sh curl https://api.supabase.com/v1/projects \ --request POST \ --header "Content-Type: application/json" \ --header "Authorization: Bearer YOUR_SECRET_TOKEN" \ --data '{ "name": "Todo App", "organization_slug": "aaaabbbbccccddddeeee", "db_pass": "SUPER_SECURE_PASSWORD", "region_selection": { "type": "smartGroup", "code": "americas" }, "desired_instance_size": "micro" }' ``` ### Pico compute instance Only select customers have access to Pico instances. Submit this [form](/solutions/ai-builders#talk-to-partnerships-team) to get access. Pico instance is our newest compute instance and the only one that scales to zero when not used. ### Recommended API keys Management API endpoints: - Get the API keys: [`GET /v1/projects/{ref}/api-keys`](https://api.supabase.com/api/v1#tag/secrets/get/v1/projects/{ref}/api-keys) - Enable the API keys: [`POST /v1/projects/{ref}/api-keys`](https://api.supabase.com/api/v1#tag/secrets/post/v1/projects/{ref}/api-keys) We are in the process of migrating away from our legacy API keys `anon` and `service_role` and towards API keys `publishable` and `secret`. You can learn more by navigating to [Upcoming changes to Supabase API Keys #29260](https://github.com/orgs/supabase/discussions/29260). Get the API keys by making a [`GET /v1/projects/{ref}/api-keys`](https://api.supabase.com/api/v1#tag/secrets/get/v1/projects/{ref}/api-keys) request. ```sh curl 'https://api.supabase.com/v1/projects/{ref}/api-keys?reveal=true' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` If the response includes `"publishable"` and `"secret"` keys then you're all set and you should only use those from now on. Otherwise, enable the API keys by making two [`POST /v1/projects/{ref}/api-keys`](https://api.supabase.com/api/v1#tag/secrets/post/v1/projects/{ref}/api-keys) requests, one for `publishable` and another for `secret`. ```sh curl 'https://api.supabase.com/v1/projects/{ref}/api-keys' \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "type": "publishable", "name": "default" }' ``` ```sh curl 'https://api.supabase.com/v1/projects/{ref}/api-keys?reveal=true' \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "type": "secret", "name": "default", "secret_jwt_template": { "role": "service_role" } }' ``` ## Changing compute sizes Management API endpoint: [`PATCH /v1/projects/{ref}/billing/addons`](https://api.supabase.com/api/v1#tag/billing/patch/v1/projects/{ref}/billing/addons) Once you have access to [Pico instances](#pico-compute-instance), you will no longer be able to upgrade or downgrade to Nano instances. You can upgrade and downgrade compute sizes by making requests to [`PATCH /v1/projects/{ref}/billing/addons`](https://api.supabase.com/api/v1#tag/billing/patch/v1/projects/{ref}/billing/addons). ```sh curl 'https://api.supabase.com/v1/projects/{ref}/billing/addons' \ --request PATCH \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "addon_type": "compute_instance", "addon_variant": "ci_small" }' ``` ## Configuration changes Management API endpoints: - Auth: [`PATCH /v1/projects/{ref}/config/auth`](https://api.supabase.com/api/v1#tag/auth/patch/v1/projects/{ref}/config/auth) - Data API (PostgREST): [`PATCH /v1/projects/{ref}/postgrest`](https://api.supabase.com/api/v1#tag/rest/patch/v1/projects/{ref}/postgrest) - Edge Functions: - [`PATCH /v1/projects/{ref}/functions/{function_slug}`](https://api.supabase.com/api/v1#tag/edge-functions/patch/v1/projects/{ref}/functions/{function_slug}) - [`PUT /v1/projects/{ref}/functions`](https://api.supabase.com/api/v1#tag/edge-functions/put/v1/projects/{ref}/functions) - Storage: [`PATCH /v1/projects/{ref}/config/storage`](https://api.supabase.com/api/v1#tag/storage/patch/v1/projects/{ref}/config/storage) - Realtime: [`PATCH /v1/projects/{ref}/config/realtime`](https://api.supabase.com/api/v1#tag/realtime-config/patch/v1/projects/{ref}/config/realtime) You can manage the configuration of all services using the Management API. ## Development workflow Supabase is a _stateful_ service: we store data. If anything breaks in production, you can't "roll back" to a point in time because doing so might cause your users to lose any data that their production environment received since the last checkpoint. Because of this, it's important that you adopt a development workflow on behalf of your users: ![Change flow](/docs/img/integrations/change-flow.png) ### Creating a `DEV` branch Management API endpoint: [`POST /v1/projects/{ref}/branches`](https://api.supabase.com/api/v1#tag/environments/post/v1/projects/{ref}/branches) After launching a project, it's important that all changes happen on a development branch. Branches can be treated like ephemeral servers: if anything goes wrong you can either revert the changes or destroy the branch and create a new one based off of production. ```sh curl 'https://api.supabase.com/v1/projects/{ref}/branches' \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "branch_name": "DEV", "secrets": { "STRIPE_SECRET_KEY":"sk_test_123..." "STRIPE_PUBLISHABLE_KEY":"pk_test_123..." } }' ``` ### Make database changes Management API endpoint: [`POST /v1/projects/{ref}/database/migrations`](https://api.supabase.com/api/v1#tag/database/post/v1/projects/{ref}/database/migrations) Only select customers have access to database migrations endpoint. Submit this [form](/solutions/ai-builders#talk-to-partnerships-team) to get access. For this example we will create a todos table using the [`POST /v1/projects/{ref}/database/migrations`](https://api.supabase.com/api/v1#tag/database/post/v1/projects/{ref}/database/migrations) endpoint. ```sql create table public.todos ( id serial primary key, task text not null ); alter table public.todos enable row level security; ``` This endpoint will automatically create a migration inside the `supabase_migrations` schema and run the migration. If the schema migration fails, the changes will be rolled back. ```sh curl https://api.supabase.com/v1/projects/{ref}/database/migrations \ --request POST \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "query": "create table public.todos (id serial primary key, task text not null); grant select on public.todos to anon; grant select, insert, update, delete on public.todos to authenticated; grant select, insert, update, delete on public.todos to service_role; alter table public.todos enable row level security;", "name": "Create a todos table" }' ``` ### Create a restore point Only select customers have access to restore points. Submit this [form](/solutions/ai-builders#talk-to-partnerships-team) to get access. After every change you make to the database, it's a good idea to create a restore point. This will allow you to roll back the database if you decide to go in a different direction. Beware that only database changes are captured when creating a restore point. ```sh curl https://api.supabase.com/v1/projects/{ref}/database/backups/restore-point \ --request POST \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "name": "abcdefg" }' ``` ### Reverting changes ![Revert](/docs/img/integrations/revert.png) Only select customers have access to restore points. Submit this [form](/solutions/ai-builders#talk-to-partnerships-team) to get access. After creating restore points, you are able to revert back to any restore point that you want. ```sh curl https://api.supabase.com/v1/projects/{ref}/database/backups/undo \ --request POST \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "name": "abcdefg" }' ``` When you revert changes, you are undo-ing all database changes since the specified restore point, including: - Schema changes - Any seed data that you inserted - Any test users who have signed up (and auth tokens for sign ins) - Pointers to files in Supabase Storage. It will not affect: - Configuration changes - Any secrets that have been added - Storage objects themselves - Any deployed Edge Functions ### Add seed data It's important that the data in development branches is NOT production data, especially for non-developers who don't understand the implications of working with data. Security and side-effects (e.g. emailing all production users) are two reasons why this is important. It's common in `DEV` branches to "seed" data. This is basically test data for users. Let's insert the following seed to our new todos table: ```sql insert into todos (task) values ('Task 1'), ('Task 2'), ('Task 3'); ``` You can use the `POST /database/query` endpoint to add data: ```sh curl https://api.supabase.com/v1/projects/{branch_ref}/database/query \ --request POST \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --header 'Content-Type: application/json' \ --data-binary @- < Before transferring the project to your user's org, make sure to remove any custom configuration that you do not want your user's project to retain. ## Platform kit Docs: https://supabase.com/ui/docs/platform/platform-kit