v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB
Database

Create database branch

Creates a new branch from the specified parent branch (or default 'main' branch). Branches provide instant point-in-time clones of your database for isolated development, staging, testing, or feature work. Perfect for testing schema changes, running migrations safely, or creating ephemeral preview environments.

post/database/v1/projects/{id}/branches

Path parameters

idstring required

Database project ID

Request body

namestring required

Branch name (letters, numbers, hyphens, underscores only)

parentBranchIdstring

Parent branch ID to clone from (defaults to main branch)

Response

Branch created successfully

idstring required

Branch ID

namestring required

Branch name

parentBranchIdstring nullable required

Parent branch ID

isDefaultboolean required

Whether this is the default branch (always false for new branches)

statusstring required

Branch status

createdAtstring date-time required

Branch creation timestamp