Skip to main content

Requirements

Unchanged from v4: Node.js 20.0.0 or newer, both ESM and CJS.

Breaking changes summary

client.users removed

Unlike the v3 to v4 migration, there is no deprecated proxy this time. client.users no longer exists, calling it throws.

Backups removed

app.backup and app.backups are gone, along with the Backup export. Snapshots are the only supported path for both applications and databases.
Use the Snapshot class for application snapshots and DatabaseSnapshot for database snapshots.

api.applications.create(file) return shape

The created application now returns richer language and resource data instead of the flat lang/ram pair.

app.network.dns() shape

dns() now returns an array of DNS records instead of a single { ownership, ssl } object.
txt records cover both ownership and SSL validation; the cname record is the traffic record. status reflects the validation state (pending, pending_validation, active, and so on).

Other changes

  • ApplicationLanguage now includes ruby, alongside javascript, typescript, python, java, elixir, go, rust, php, dotnet and static.
  • Error codes were standardized. New names are exported through APIErrorCode; the old names remain available as deprecated type aliases. See error codes for the full rename table.