Skip to main content
Koru
Get started
API reference sections

Schema

WorkspaceLifecycleOutcome

What the operation actually did, in the order it did it.

Every field is a fact about this call, and the shape is the same whether it succeeded. S24 is a partial failure - the terminals are closed and the catalog is unchanged - and a caller that has to report that truth needs the same body it would have read on success, not a bare error string.

Type object

Shape

FieldTypeDescription
workspacerequiredstring
actionrequiredWorkspaceLifecycleAction

What POST /v1/workspaces/{id}/lifecycle is being asked to do.

Three verbs, and no permanent delete. There is no purge route anywhere in Koru - the retention sweep is the only thing that removes bytes - so naming one here would be describing an operation that does not exist.

terminated_sessionsrequiredarray of string

The sessions this call closed. Empty on a retry, and empty for restore, which closes nothing.

sessions_closedrequiredboolean

Whether step 3 completed. false means nothing after it was attempted.

mutation_appliedrequiredboolean

Whether step 4 committed. false with sessions_closed: true is exactly S24, and the retry is the same request again.

authority_committedboolean or null
listingListingState or null
replacementReplacement or null
Example
{
  "workspace": "string",
  "action": "archive",
  "terminated_sessions": [
    "string"
  ],
  "sessions_closed": false,
  "mutation_applied": false,
  "authority_committed": false,
  "listing": {
    "state": "applied"
  },
  "replacement": {
    "state": "created",
    "workspace": {
      "id": "00000000-0000-4000-8000-000000000000",
      "owner": {},
      "name": "string",
      "created_at": 0,
      "last_opened_at": 0,
      "icon": "string",
      "color": "string",
      "pinned": false,
      "archived": false,
      "deleted_at": 0,
      "position": 0
    }
  }
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.