Skip to content
Management API Reference

[Beta] Diffs a database branch

get/v1/branches/{branch_id_or_ref}/diff

Diffs the specified database branch

OAuth scopes

  • environment:write

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

  • branching_development_write
  • or
  • branching_production_write

Path parameters

  • branch_id_or_ref
    Required
    any of the following options

    Branch ref or deprecated branch ID

Query parameters

  • included_schemas
    Optional
    string
  • pgdelta
    Optional
    string

    Use pg-delta instead of Migra for diffing when true. Boolean string.

    Truthy values: true, 1, yes, on, y, enabled

    Falsy values: false, 0, no, off, n, disabled

Response codes

  • 200
  • 500

Response (200)

1
{}