Skip to content

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
  • 401
  • 403
  • 429
  • 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"
}
{
  "type": "object",
  "properties": {
    "ref": {
      "type": "string"
    },
    "postgres_version": {
      "type": "string"
    },
    "postgres_engine": {
      "type": "string"
    },
    "release_channel": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "INACTIVE",
        "ACTIVE_HEALTHY",
        "ACTIVE_UNHEALTHY",
        "COMING_UP",
        "UNKNOWN",
        "GOING_DOWN",
        "INIT_FAILED",
        "REMOVED",
        "RESTORING",
        "UPGRADING",
        "PAUSING",
        "RESTORE_FAILED",
        "RESTARTING",
        "PAUSE_FAILED",
        "RESIZING"
      ]
    },
    "db_host": {
      "type": "string"
    },
    "db_port": {
      "type": "integer",
      "exclusiveMinimum": true,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "db_user": {
      "type": "string"
    },
    "db_pass": {
      "type": "string"
    },
    "jwt_secret": {
      "type": "string"
    }
  },
  "required": [
    "ref",
    "postgres_version",
    "postgres_engine",
    "release_channel",
    "status",
    "db_host",
    "db_port"
  ]
}