BUbudibase
workspaces

Export a workspace 🔒

Changed on

This endpoint is only available on an enterprise license.

post/workspaces/{workspaceId}/export

Request

  • Base URL
    https://budibase.app/api/public/v1
  • URL
    https://budibase.app/api/public/v1/workspaces/{workspaceId}/export
  • Auth
    API key in header x-budibase-api-key

Path parameters

workspaceIdstring required

The ID of the workspace which this request is targeting.

Request body

encryptPasswordstring required

An optional password used to encrypt the export.

excludeRowsboolean required

Set whether the internal table rows should be excluded from the export.

Response

A gzip tarball containing the workspace export, encrypted if password provided.

Changes