Auth

26 operations, generated from apps/api/openapi.yaml (OpenAPI 3.2). Each page has the parameters, request body, responses and code samples, and a Send button to try the request against your cloud instance.

• GET/v1/workspace/usageCurrent plan and usageCurrent plan and usage (the Community Edition reports the unlocked plan, named Community Edition)
• POST/v1/device-linksCreate a one-time "connect a device" linkCreate a one-time "connect a device" link (QR code)
• POST/v1/device-links/redeemExchange a device-link token for a session cookie
• POST/v1/sessions/recoverRecover access with the recovery keyRecover access with the recovery key (lost API key)
• POST/v1/sessions/api-keySign in to the dashboard with an admin API keySign in to the dashboard with an admin API key (or, in the Community Edition, the access token)
• GET/v1/sessionCurrent principal, workspace and CSRF token
• DELETE/v1/sessionLog outLog out (revoke the current session)
• POST/v1/session/onboardedFinishFinish (or skip) the welcome wizard
• GET/v1/sessionsList active browser sessionsList active browser sessions (admin)
• DELETE/v1/sessions/{id}Revoke a sessionRevoke a session (admin)
• GET/v1/workspaceGet the workspace
• DELETE/v1/workspacePermanently delete this workspace and all its dataPermanently delete this workspace and all its data (cloud, dashboard session only)
• PATCH/v1/workspaceRename the workspace or change its time zoneRename the workspace or change its time zone (admin)
• POST/v1/recovery-key/rotateIssue a new recovery keyIssue a new recovery key (dashboard sessions only)
• GET/v1/access-tokenThe Community Edition's access tokenThe Community Edition's access token (dashboard sessions and the token itself)
• POST/v1/access-token/rotateMake a new access tokenMake a new access token (Community Edition)
• GET/v1/api-keysList API keysList API keys (admin)
• POST/v1/api-keysCreate a scoped API keyCreate a scoped API key (admin). The raw key is returned once.
• DELETE/v1/api-keys/{id}Revoke an API keyRevoke an API key (admin)
• POST/v1/api-keys/{id}/rotateRevoke a key and issue a replacement with the same name and scopesRevoke a key and issue a replacement with the same name and scopes (admin)
• GET/v1/agentsAgents seen talking to the workspace, most recently active first
• DELETE/v1/agents/{id}Remove an agent from the listRemove an agent from the list (it comes back when it talks to the workspace again)
• POST/v1/workspace/exportStart a workspace exportStart a workspace export (admin; GDPR data portability)
• GET/v1/workspace/exportsThe workspace's latest exportsThe workspace's latest exports (backups), newest first, at most 20 (admin)
• GET/v1/workspace/exports/{id}Export job statusExport job status (admin)
• GET/v1/workspace/exports/{id}/downloadDownload a finished exportDownload a finished export (admin)