workspace

create forked workspace

Changed on
post/w/{workspace}/workspaces/create_fork

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/workspaces/create_fork
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

backgroundboolean

return once the request is validated and create the fork in the background, answering with the creation id getForkCreationStatus reads

Request body

idstring required
namestring required
colorstring
shared_ducklakesstring[]

Lake names the fork SHARES with the parent (reads and writes the parent's lake directly). Every lake not listed gets the default isolated fork namespace with read-defer to the parent.

is_dev_workspaceboolean

Create the fork as a persistent dev workspace (id not required to carry the wm-fork- prefix; at most one per parent)

lock_prod_deployboolean

When creating a dev workspace, lock the parent (prod) against direct deployment

lock_prod_forkingboolean

When creating a dev workspace, prevent forking the parent (prod)

copy_membersboolean

Copy the parent's members (users + group memberships) into the fork so the team can work in it

dev_workspace_label'dev' | 'qa' | 'test' | 'uat' | 'staging' | 'demo' | 'sandbox' | 'preprod'

Environment label for the dev workspace: its badge text and the branch it deploys to. Ignored for non-dev forks. Omitted defaults to 'dev'

Response

forked workspace created, or with background set, the id of its creation

Changes