Groundfloor Docs

Offboarding

Freeze and hard-delete workspaces with a 30-day retention window and lifecycle events.

Workspace offboarding is a two-phase process: freeze (immediate suspension) then hard-delete (after retention).

Freeze

Freezing a workspace:

  1. Sets status = frozen and frozen_at timestamp
  2. Sets retention_until = now + 30 days
  3. Emits client.suspended lifecycle event
  4. Blocks normal operations on the workspace

In the Customer Portal, freeze is available to workspace administrators from the workspace detail page. See Workspaces.

POST /v1/workspaces/{workspace_id}/freeze
Authorization: Bearer <token>

Requires administer on the workspace.

Hard delete

After retention_until passes, a background offboarding reconciler hard-deletes:

  • Workspace row and environments
  • Memberships
  • SpiceDB relationships
  • Dataplane tenant (via Admin SDK)

Emits client.offboarded when complete.

Hard delete is irreversible. Export data before freezing if you need a backup. See workspace export on the API.

Export before offboard

POST /v1/workspaces/{workspace_id}/export

Returns a downloadable archive of workspace metadata and pillar data where supported. Run this before freeze for compliance retention.

Audit trail

Freeze and delete actions are recorded in the audit log. Secret reveals and membership changes during the retention window are also captured.

Workspace Provisioning

The four-step provisioning saga that creates workspaces, environments, and Dataplane tenants.

Event Emission

Lifecycle events published to Redpanda topics from Control Plane — provisioning, membership, billing.

On this page

FreezeHard deleteExport before offboardAudit trailRelated