Sign in
Environments

Get database branch config

Fetches configurations of the specified database branch

get/v1/branches/{branch_id_or_ref}

Path parameters

string required

Project ref

OR
string uuid required
Example:abcdefghijklmnopqrst

Branch ref or deprecated branch ID

Response

refstring required
postgres_versionstring required
postgres_enginestring required
release_channelstring required
status'INACTIVE' | 'ACTIVE_HEALTHY' | 'ACTIVE_UNHEALTHY' | 'COMING_UP' | 'UNKNOWN' | 'GOING_DOWN' | 'INIT_FAILED' | 'REMOVED' | 'RESTORING' | 'UPGRADING' | 'PAUSING' | 'RESTORE_FAILED' | 'RESTARTING' | 'PAUSE_FAILED' | 'RESIZING' required
db_hoststring required
db_portinteger required
db_userstring
db_passstring
jwt_secretstring

Changes