账户 API 参考
Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。
Link API 参考
Link API。
共 8 个端点,其中 3 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。
01
通用
| 端点 | 权限 | 参数 | CLI · MCP 工具 |
|---|---|---|---|
GET /link/popsLanding points a tunnel can use | 只读 | — | orbit link popslink_pops |
GET /link/tunnelsList your tunnels | 只读 | — | orbit link listlink_list |
POST /link/tunnelsCreate a tunnel (the credential is returned once) | 读写 | 请求体: name* string, pop_id* integer, pop_id2 integer, local_url* string | orbit link createlink_create |
GET /link/tunnels/{id}One tunnel | 只读 | id integer | orbit link get <id>link_get |
PATCH /link/tunnels/{id}Rename, move landing point, change the local address, enable or disable | 读写 | id integer请求体: name* string, pop_id* integer, pop_id2 integer, local_url* string | orbit link patch <id>link_patch |
DELETE /link/tunnels/{id}Delete a tunnel and free its address | 读写 | id integer | orbit link delete <id>link_delete |
PUT /link/tunnels/{id}/hostnamesSet the hostnames a tunnel serves (idempotent; creates, repoints and removes the Shield sites it manages) | 读写 | id integer请求体: managed_by* string, hostnames* string[], adopt boolean | orbit link hostnames <id>link_hostnames |
POST /link/tunnels/{id}/tokenRotate the tunnel credential | 读写 | id integer | orbit link token <id>link_token |