workspace-activation

Create Workspace Activation Key

Changed on

Issue the workspace's setup API key, rotating the one the guide already issued.

Workspace owners and admins only, like every other action that changes a workspace. The plaintext is returned once and never stored, so a reopened guide rotates the same key row rather than collecting a second one, and answers 409 once the workspace has activated or the guide was dismissed.

post/api/v1/workspaces/{workspace_id}/activation/key

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

workspace_idstring uuid required

Response

Successful Response

keystring required
key_idstring required
key_namestring nullable required
key_prefixstring nullable required
key_suffixstring nullable required

Changes