/
SU
supabase
/
Supabase API (v1)
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 2mo ago · Updated 2mo ago
Details
Filter operations
Advisors
2
Analytics
5
Auth
18
Billing
3
Database
46
get
Lists SQL snippets for the logged in user
get
Gets a specific SQL snippet
get
[Beta] Get project's temporary access configuration.
put
[Beta] Update project's temporary access configuration.
get
[Beta] Get project's SSL enforcement configuration.
put
[Beta] Update project's SSL enforcement configuration.
get
Generate TypeScript types
get
Returns project's readonly mode status
post
Disables project's readonly mode for the next 15 minutes
post
[Beta] Set up a read replica
post
[Beta] Remove a read replica
post
[Beta] Create a login role for CLI with temporary password
delete
[Beta] Delete existing login roles used by CLI
get
List applied migration versions
put
Upsert a database migration without applying
post
Apply a database migration
delete
Rollback database migrations and remove them from history table
get
Fetch an existing entry from migration history
patch
Patch an existing entry in migration history
post
[Beta] Run sql query
post
[Beta] Run a sql query as supabase_read_only_user
post
[Beta] Enables Database Webhooks on the project
get
Gets database metadata for the given project.
patch
Updates the database password
get
Get user-id to role mappings for JIT access
put
Updates a user mapping for JIT access
post
Authorize user-id to role mappings for JIT access
get
List all user-id to role mappings for JIT access
post
Invites an external user to a database for JIT access
post
Accepts invitation for JIT database access
delete
Deletes the invite for an external user to a database for JIT access
delete
Delete JIT access by user-id
get
Get PostgREST OpenAPI spec
get
Get project's pgbouncer config
get
Gets project's supavisor config
patch
Updates project's supavisor config
get
Gets project's Postgres config
put
Updates project's Postgres config
get
Lists all backups
post
Restores a PITR backup for a database
get
Get restore points for project
post
Initiates a creation of a restore point for a database
post
Restores a physical backup for a database
get
Gets the backup schedule for a project
patch
Updates the backup schedule time for a project
post
Initiates an undo to a given restore point
Domains
9
Edge Functions
8
Environments
17
OAuth
4
Organizations
7
Profile
1
Projects
29
Realtime
3
Rest
2
Secrets
12
Storage
3
Database
Lists all backups
get
/v1/projects/{ref}/database/backups
Path parameters
ref
string
required
Example:
abcdefghijklmnopqrst
Project ref
Response
V1BackupsResponse
required
region
string
required
walg_enabled
boolean
required
pitr_enabled
boolean
required
backups
object[]
required
physical_backup_data
object
required
Changes