Account API reference
Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.
Link API reference
Link API.
8 endpoints, 3 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.
01
General
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /link/popsLanding points a tunnel can use | read | — | orbit link popslink_pops |
GET /link/tunnelsList your tunnels | read | — | orbit link listlink_list |
POST /link/tunnelsCreate a tunnel (the credential is returned once) | write | body: name* string, pop_id* integer, pop_id2 integer, local_url* string | orbit link createlink_create |
GET /link/tunnels/{id}One tunnel | read | id integer | orbit link get <id>link_get |
PATCH /link/tunnels/{id}Rename, move landing point, change the local address, enable or disable | write | id integerbody: 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 | write | 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) | write | id integerbody: managed_by* string, hostnames* string[], adopt boolean | orbit link hostnames <id>link_hostnames |
POST /link/tunnels/{id}/tokenRotate the tunnel credential | write | id integer | orbit link token <id>link_token |
Next
Related
Organization API reference
Every Organization endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.
Services API reference
Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.