Skip to content
Get started

Archive a workspace

client.workspaceAdmin.archive(stringworkspaceID, RequestOptionsoptions?): void
DELETE/v1/account/workspaces/{workspaceId}

Archives a workspace (soft delete). The workspace is retained, but any subsequent request scoped to it returns a permission error. Archiving the account’s last active (non-archived) workspace is not allowed and returns FailedPrecondition. Admin only.

ParametersExpand Collapse
workspaceID: string

Archive a workspace

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

await client.workspaceAdmin.archive('workspaceId');
Returns Examples