Skip to content
Management API Reference

Get database branch config

get/v1/branches/{branch_id_or_ref}

Fetches configurations of the specified database branch

OAuth scopes

  • environment:read

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ref or deprecated branch ID

Response codes

  • 200
  • 500

Response (200)

1
{
2
  "ref": "lorem",
3
  "postgres_version": "lorem",
4
  "postgres_engine": "lorem",
5
  "release_channel": "lorem",
6
  "status": "INACTIVE",
7
  "db_host": "lorem",
8
  "db_port": 1,
9
  "db_user": "lorem",
10
  "db_pass": "lorem",
11
  "jwt_secret": "lorem"
12
}