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

The fine-grained token must include the following permissions to access this endpoint:

  • branching_development_read
  • or
  • branching_production_read

Path parameters

  • branch_id_or_ref
    Required
    any of the following options

    Branch ref or deprecated branch ID

Response codes

  • 200
  • 500

Response (200)

{
  "ref": "lorem",
  "postgres_version": "lorem",
  "postgres_engine": "lorem",
  "release_channel": "lorem",
  "status": "INACTIVE",
  "db_host": "lorem",
  "db_port": 1,
  "db_user": "lorem",
  "db_pass": "lorem",
  "jwt_secret": "lorem"
}