Skip to main content
Koru
Get started
API reference sections

Schema

WorkspaceLifecycleAction

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.

Type "archive" or "soft_delete" or "restore"

Shape

One of 3 shapes:

  1. Variant 1

    Hide the workspace and its projects. Reversible; its terminals close.

    "archive"

  2. Variant 2

    Move the workspace to the trash. Recoverable until the retention window purges it; its terminals close.

    "soft_delete"

  3. Variant 3

    Bring a soft-deleted workspace back. Closes nothing - its projects reappear with no project mutation.

    "restore"

Example
"archive"

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

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.