Services API reference

Services API.

15 endpoints, 8 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.

General

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /services` List my services	read	`?limit` integer `?offset` integer	`orbit services list` `services_list`
`GET /services/{id}` Get a service	read	`id` integer	`orbit services get <id>` `services_get`
`POST /services/{id}/transfer` Move a service (with its zones, sites and rules) to yourself or to a team you administer	write	`id` integer body: `to`* string	`orbit services transfer <id>` `services_transfer`
`POST /services/{id}/rule-test` Check what a name would do against the custom rules	read	`id` integer body: `name` string, `qtype` string, `rules` string	`orbit services ruletest <id>` `services_ruletest`
`GET /services/{id}/query-log` Recent queries (private resolvers with logging on)	read	`id` integer `?q` string `?action` pass \| blocked \| rewritten \| safesearch \| ratelimited `?limit` integer	`orbit services querylog <id>` `services_querylog`
`GET /services/{id}/stats` Resolver statistics	read	`id` integer `?days` integer	`orbit services dnsstats <id>` `services_dnsstats`

filter

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /services/{id}/filter` Resolver filter lists and rewrites	read	`id` integer	`orbit services filter get <id>` `services_filter_get`
`PUT /services/{id}/filter` Replace resolver filter lists / rewrites	write	`id` integer body: `custom_block` string, `custom_allow` string, `rewrites` string, `block_mode` nxdomain \| zero \| page, `filter_lists` string	`orbit services filter put <id>` `services_filter_put`

policy

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /services/{id}/policy` Resolver filtering policy	read	`id` integer	`orbit services policy get <id>` `services_policy_get`
`PUT /services/{id}/policy` Update the resolver filtering policy	write	`id` integer body: `rules` string, `blocked_services` string, `schedule_json` string, `tz` string, `safesearch` string, `block_bypass` boolean, `log_mode` off \| blocked \| all, `log_days` integer, `anonymize_ip` boolean, `ratelimit` integer, `ttl_min` integer, `ttl_max` integer, `access_allow` string, `access_deny` string, `forwards` string, `paused_until` string	`orbit services policy put <id>` `services_policy_put`

clients

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /services/{id}/clients` List client groups	read	`id` integer	`orbit services clients list <id>` `services_clients_list`
`POST /services/{id}/clients` Create a client group	write	`id` integer body: `id` integer, `name` string, `client_id` string, `addrs` string, `tags` string, `enabled` boolean, `paused_until` string, `lists` string, `rules` string, `blocked_services` string, `safesearch` string, `block_mode` string, `log_mode` string	`orbit services clients create <id>` `services_clients_create`
`PATCH /services/{id}/clients/{client_id}` Update a client group	write	`id` integer `client_id` integer body: `id` integer, `name` string, `client_id` string, `addrs` string, `tags` string, `enabled` boolean, `paused_until` string, `lists` string, `rules` string, `blocked_services` string, `safesearch` string, `block_mode` string, `log_mode` string	`orbit services clients patch <id> <client_id>` `services_clients_patch`
`DELETE /services/{id}/clients/{client_id}` Delete a client group	write	`id` integer `client_id` integer	`orbit services clients delete <id> <client_id>` `services_clients_delete`
`POST /services/{id}/clients/{client_id}/ddns-token` Issue or revoke a dynamic-address update token	write	`id` integer `client_id` integer body: `revoke` boolean	`orbit services clients token <id> <client_id>` `services_clients_token`

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.

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.

DNS API reference

Every DNS endpoint in the Orbit API (30): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation