database

Create a database branch

Changed on

Creates a new database branch. If a branch already exists for the specified branch ID, returns the existing connection string.

post/sites/{site_id}/database/branch

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/sites/{site_id}/database/branch
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Request body

parent_branch_idstring

The ID of the parent branch to create the new branch from. Defaults to the production branch if not specified.

branch_idstring required

The branch identifier

metadataobject

Arbitrary metadata to associate with the branch

Response

Branch already exists

connection_stringstring

The connection string for the database branch

metadataobject

Metadata associated with the branch

Changes