workspace-activation

Get Workspace Activation

Changed on

Where a workspace stands on its first successful request.

Readable by any member who can see the workspace. Whether the guide should actually be offered to this caller is experience_eligible, which also answers false when the deployment has the flow turned off (activation_guide), so a dashboard left open stops offering it without needing to be reloaded.

get/api/v1/workspaces/{workspace_id}/activation

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

dismissedboolean required

Whether someone skipped the guide for this workspace.

experience_eligibleboolean required

Whether the dashboard should offer the guide to this caller right now: the deployment has it enabled, the workspace is classified for it, nobody dismissed it, no request has succeeded yet, and the caller may manage the workspace.

status'waiting' | 'failed' | 'activated' required

'activated' once a gateway request in this workspace has succeeded, 'failed' when the last one failed and none has yet succeeded, 'waiting' when there has been none at all.

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id get_workspace_activation_api_v1_workspaces__workspace_id__activation_get removed and replaced with workspace-activation-get_workspace_activation