Archive Flow workspace

Archive an empty Flow workspace through canonical Auth and remove its local mirror.

Outcome

Archive an empty Flow workspace through canonical Auth and remove its local mirror.

Before you start

Verify authenticated identity, environment and the approved organization context before preparing an action.
The published application permission is workspace:delete. Discover and bind the exact granted Flow workspace. Supplied ids do not grant access.
Session callers need admin workspace access. Auth-introspected API keys must bind that workspace and satisfy workspace:write and workspace:delete. The application permission and workspace boundary are separate checks.
Authorize the documented mutation effects before CLI --confirm or MCP confirm:true. Fixture credentials and ids authorize no live operation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_flow.workspaces.delete --detail --json
topolo resources topolo-flow --json
topolo workspaces list topolo-flow --json

Set FLOW_WORKSPACE_ID to the exact id returned by granted workspace discovery.

Request

DELETE /api/workspaces/{workspaceId}

Inspect and test this action. Save the exact input object as payload.json; resource context is supplied separately.

Input fields

Field	Required	Meaning	Constraints
`workspaceId`	Required	Exact canonical workspace granted for this request; archival also requires an existing empty local mirror.	{"minLength":1}

View the full input schema through the action reference or CLI/MCP discovery.

Effects

Requires the selected authorized workspace and an existing local mirror; any flow, run, approval, notification-outbox or connection-alert row blocks archival. Auth archival occurs before local mirror removal; a refused Auth call leaves the mirror. Organization-level Nexus connections are not removed.
Session callers need admin access to the exact granted Flow workspace, in addition to the published application permission. Auth-introspected API keys use their bound workspace and workspace:write and the published workspace:delete permission; supplying an id never grants access.

Interpret the response

Read $.workspaceId for the returned workspace identifier. An empty collection does not discover a target.

Read canonical workspace state through topolo workspaces list and inspect scoped empty flows/runs/approvals. Local ok does not delete Auth identity or Nexus credentials.

View the complete success schema. Success examples below preserve the actual exported Worker responses; errors have their original refusal shapes. CLI/MCP add their transport envelope, and --detail requests the full CLI response.

Worked examples

Captured from the actual exported Flow Worker with both local SQLite D1 stores and all committed migrations, synthetic Auth identity/grants and simulated Nexus, archive and Workflow-acceptance transports. Fixture credentials and identifiers authorize no live operation. No live provider invocation, credential storage, notification delivery, metering acceptance, durable Workflow execution, deployment, backup erasure or production completion is established by these captures. Refused examples explain boundaries and must not be executed as successful workflows.

Refused request · HTTP 502

Actual exported Worker response with both local SQLite D1 databases and all committed migrations; synthetic Auth/grants and simulated Nexus/archive transport. No live credentials, provider calls, delivery, deployment or durable Workflow execution proof. Scenario: platform archival refused.

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 502:

{
  "error": "workspace_archive_refused"
}

HTTP 502. The handler refused this request. Resolve the exact cause before retrying; invalid input can be refused by CLI validation before reaching the handler.

Successful request

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --confirm --detail --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_flow.workspaces.delete",
    "input": {
      "workspaceId": "ws_flow_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<id returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "ok": true,
  "workspaceId": "ws_flow_fixture"
}

HTTP 200. Read canonical workspace state through topolo workspaces list and inspect scoped empty flows/runs/approvals. Local ok does not delete Auth identity or Nexus credentials.

Refused request · HTTP 401

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 401:

{
  "error": "Authentication token required"
}

HTTP 401. The handler refused this request. Resolve the exact cause before retrying; invalid input can be refused by CLI validation before reaching the handler.

Refused request · HTTP 403

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": "This workspace requires admin access",
  "code": "workspace_access_insufficient"
}

HTTP 403. The handler refused this request. Resolve the exact cause before retrying; invalid input can be refused by CLI validation before reaching the handler.

Refused request · HTTP 403

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": "This workspace requires admin access",
  "code": "workspace_access_insufficient"
}

HTTP 403. The handler refused this request. Resolve the exact cause before retrying; invalid input can be refused by CLI validation before reaching the handler.

Refused request · HTTP 409

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 409:

{
  "error": "workspace_not_empty"
}

HTTP 409. The handler refused this request. Resolve the exact cause before retrying; invalid input can be refused by CLI validation before reaching the handler.

Refused request · HTTP 404

Input · payload.json:

{
  "workspaceId": "ws_flow_fixture"
}

CLI:

topolo actions validate app_topolo_flow.workspaces.delete --data @payload.json --json
topolo actions plan app_topolo_flow.workspaces.delete --resource-type workspace --resource-id "$FLOW_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": "workspace_not_found"
}

HTTP 404. The handler refused this request. Resolve the exact cause before retrying; invalid input can be refused by CLI validation before reaching the handler.

Verify the result

Read canonical workspace state through topolo workspaces list and inspect scoped empty flows/runs/approvals. Local ok does not delete Auth identity or Nexus credentials.

Errors and recovery

Authentication token required (HTTP 401): Authenticate normally in the approved environment and organization, verify identity, then rediscover the action and its granted resource before retrying.
workspace_archive_refused (HTTP 502): Read canonical status after uncertain archival before retrying. There is no published restore action; do not recreate identity or remove occupied data to force archival.
workspace_not_found (HTTP 404): Read canonical status after uncertain archival before retrying. There is no published restore action; do not recreate identity or remove occupied data to force archival.
workspace_not_empty (HTTP 409): Read canonical status after uncertain archival before retrying. There is no published restore action; do not recreate identity or remove occupied data to force archival.
organization_required (HTTP 403): Authenticate into the specifically approved organization. Do not guess a different organization or bypass the refusal.
action_permission_required (HTTP 403): The credential lacks the exact published application permission. Stop and obtain authorized access; changing target ids cannot grant it.
workspace_required (HTTP 400): Discover an explicitly granted Flow workspace and bind its exact resource id.
forbidden (HTTP 403): The path workspace must equal the granted workspace and the credential must satisfy workspace:delete. A session additionally needs an admin workspace grant. Stop on a denial.
workspace_archive_refused (HTTP 409): Canonical Auth refused archival. Read its actual status and resolve the refusal without bypassing the workspace policy.
workspace_access_insufficient (HTTP 403): Stop when the selected workspace grant is insufficient. Obtain authorized admin access, or an Auth-introspected key with the correct workspace binding and workspace:write and the published workspace:delete permission; do not widen context or retry with guessed ids.

Preserve the exact status, response, request id and resource context. Runtime input validation, authentication and platform resource resolution can refuse a request before the handler. Dynamic dependency messages are not stable provider error codes.

Recovery boundary

Read canonical status after uncertain archival before retrying. There is no published restore action; do not recreate identity or remove occupied data to force archival.

Get Flow workspace context: Resolve authenticated identity, organization and the granted active Flow workspace.

Evidence

Captured from the actual exported Flow Worker with both local SQLite D1 stores and all committed migrations, synthetic Auth identity/grants and simulated Nexus, archive and Workflow-acceptance transports. Fixture credentials and identifiers authorize no live operation. No live provider invocation, credential storage, notification delivery, metering acceptance, durable Workflow execution, deployment, backup erasure or production completion is established by these captures. Original scenario labels and response digests are retained in the source fixtures.

Archive Flow workspace

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Refused request · HTTP 502

Successful request

Refused request · HTTP 401

Refused request · HTTP 403

Refused request · HTTP 403

Refused request · HTTP 409

Refused request · HTTP 404

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence