database

Get a database branch

Changed on

Returns the database branch connection string for a specific branch.

get/sites/{site_id}/database/branch/{branch_id}

Request

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

Query parameters

role'netlifydb_owner' | 'netlifydb_readonly'

The database role to use for the connection string. Defaults to netlifydb_owner if not specified.

Response

OK

connection_stringstring

The connection string for the database branch

metadataobject

Metadata associated with the branch

Changes