Skip to content

Terminus Info

terminus-info 是一个无需鉴权的接口,我们将一些系统可以对外展示的信息放在这里。可以理解为它是房子的门牌。

外部调用

https://<username>.myterminus.com/api/terminus-info

数据结构

json
interface TerminusInfo {
    terminusName: string;
    wizardStatus: string;
    selfhosted: boolean;
    tailScaleEnable: boolean;
    osVersion: string;
    avatar: string;
    loginBackground: string;
    terminusId: string;
}

字段含义

字段解释
terminusName用户的 Terminus Name。格式是: pengpeng@snowinning.com
wizardStatusTerminus 的激活状态,有以下状态:
wait_activate_vault,vault_activating,vault_activate_failed,wait_activate_system,system_activating,system_activate_failed,wait_activate_network,network_activating,network_activate_failed,wait_reset_password, completed
当状态为 completed 时,代表用户激活成功。在用户激活成功前,不推荐第三方程序进行太多业务相关的逻辑。
selfhosted用户所在的 Terminus 是否运行在 Terminus Space 上
tailScaleEnable用户是否激活了 TailScale,如果激活了私有入口只能通过 VPN 访问
用途:TermiPass 在连接 Terminus 时,不根据这个变量决定是否增加 local 访问
osVersionTerminus 的系统版本
avatar用户的头像
用途:用来显示用户的头像,可以参考文档 Avatar
loginBackgroundlogin 界面的背景图
用途:在 login 页面时,前端没有 acesstoken,拿不到用户更新过的壁纸
terminusId用户在每次激活时,都会生成一个新的唯一 ID
用途:TermiPass 在连接 Terminus 时,会判断当前的 Terminus 是否是之前那一台