ORBIT

DNS API 参考

DNS API。

共 30 个端点,其中 13 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。

01

通用

端点	权限	参数	CLI · MCP 工具
`GET /dns/lists` The blocklist catalogue	只读	—	`orbit dns lists` `dns_lists`

02

zones

端点	权限	参数	CLI · MCP 工具
`GET /dns/zones` List zones	只读	`?limit` integer `?offset` integer `?service_id` integer	`orbit dns zones list` `dns_zones_list`
`POST /dns/zones` Create a zone	读写	请求体: `service_id`* integer, `name`* string, `mode` zone \| host	`orbit dns zones create` `dns_zones_create`
`GET /dns/zones/{id}` Get a zone	只读	`id` integer	`orbit dns zones get <id>` `dns_zones_get`
`PATCH /dns/zones/{id}` Enable/disable or set secondary master	读写	`id` integer 请求体: `enabled` boolean, `secondary_master` string, `negative_ttl` integer	`orbit dns zones patch <id>` `dns_zones_patch`
`DELETE /dns/zones/{id}` Delete a zone (and its records, Shield sites, rules)	读写	`id` integer	`orbit dns zones delete <id>` `dns_zones_delete`
`POST /dns/zones/{id}/verify` Check NS delegation; activates the zone when it points at ns1/ns2	读写	`id` integer	`orbit dns zones verify <id>` `dns_zones_verify`
`GET /dns/zones/{id}/dnssec` DNSSEC status with DS / DNSKEY	只读	`id` integer	`orbit dns zones dnssec get <id>` `dns_zones_dnssec_get`
`PUT /dns/zones/{id}/dnssec` Enable or disable DNSSEC (online-signed ECDSA P-256)	读写	`id` integer 请求体: `enabled`* boolean	`orbit dns zones dnssec put <id>` `dns_zones_dnssec_put`
`GET /dns/zones/{id}/grants` People this zone is shared with	只读	`id` integer	`orbit dns zones grants list <id>` `dns_zones_grants_list`
`PUT /dns/zones/{id}/grants/{email}` Share the zone with a person (viewer or operator)	读写	`id` integer `email` string 请求体: `role`* viewer \| operator	`orbit dns zones grants put <id> <email>` `dns_zones_grants_put`
`DELETE /dns/zones/{id}/grants/{email}` Stop sharing the zone with a person	读写	`id` integer `email` string	`orbit dns zones grants delete <id> <email>` `dns_zones_grants_delete`
`GET /dns/zones/{id}/transfer` Outbound AXFR allowlist, NOTIFY targets, TSIG	只读	`id` integer	`orbit dns zones transfer get <id>` `dns_zones_transfer_get`
`PUT /dns/zones/{id}/transfer` Set transfer settings	读写	`id` integer 请求体: `allow` string[], `notify` string[], `tsig` boolean	`orbit dns zones transfer put <id>` `dns_zones_transfer_put`
`GET /dns/zones/{id}/analytics` Query analytics merged across PoPs	只读	`id` integer	`orbit dns zones analytics <id>` `dns_zones_analytics`
`GET /dns/zones/{id}/export` Export as a BIND zone file	只读	`id` integer	`orbit dns zones export <id>` `dns_zones_export`
`POST /dns/zones/{id}/import` Import a BIND zone file (preview or apply); SOA and apex NS are ignored, exact duplicates skipped	读写	`id` integer 请求体: `text`* string, `mode` preview \| apply, `replace` boolean	`orbit dns zones import <id>` `dns_zones_import`
`POST /dns/zones/{id}/migration/plan` Where is this zone served today, and how can it move to Orbit	只读	`id` integer	`orbit dns zones migration plan <id>` `dns_zones_migration_plan`
`POST /dns/zones/{id}/migration/apply` Import the zone (AXFR from the current master, or a zone file), then follow the registrar steps	读写	`id` integer 请求体: `mode`* axfr \| zonefile \| fresh, `master_ip` string, `zonefile` string	`orbit dns zones migration apply <id>` `dns_zones_migration_apply`

03

ranges

端点	权限	参数	CLI · MCP 工具
`GET /dns/zones/{id}/ranges` Address-range grants in a reverse zone	只读	`id` integer	`orbit dns ranges list <id>` `dns_ranges_list`
`POST /dns/zones/{id}/ranges` Grant an address range inside a reverse zone	读写	`id` integer 请求体: `prefix`* string, `owner` string, `external_ref` string, `note` string	`orbit dns ranges create <id>` `dns_ranges_create`
`PATCH /dns/zones/{id}/ranges/{rid}` Move a grant to another range or owner	读写	`id` integer `rid` integer 请求体: `prefix` string, `owner` string, `note` string, `enabled` boolean	`orbit dns ranges patch <id> <rid>` `dns_ranges_patch`
`DELETE /dns/zones/{id}/ranges/{rid}` Withdraw a grant (records are left alone)	读写	`id` integer `rid` integer	`orbit dns ranges delete <id> <rid>` `dns_ranges_delete`
`GET /dns/ranges` Every address range granted to you, across zones	只读	—	`orbit dns ranges mine` `dns_ranges_mine`
`POST /dns/ranges` Grant an address range without naming a zone; the covering reverse zone is found for you	读写	请求体: `prefix`* string, `owner` string, `external_ref` string, `note` string	`orbit dns ranges grant` `dns_ranges_grant`

04

records

端点	权限	参数	CLI · MCP 工具
`GET /dns/zones/{id}/records` List records	只读	`id` integer `?limit` integer `?offset` integer	`orbit dns records list <id>` `dns_records_list`
`POST /dns/zones/{id}/records` Add a record	读写	`id` integer 请求体: `name` string, `type`* A \| AAAA \| PTR \| CNAME \| TXT \| MX \| NS \| SRV \| CAA \| ALIAS \| HTTPS \| SVCB, `ttl` integer, `content`* string, `weight` integer, `health_check` string	`orbit dns records create <id>` `dns_records_create`
`GET /dns/zones/{id}/records/{rid}` Get a record	只读	`id` integer `rid` integer	`orbit dns records get <id> <rid>` `dns_records_get`
`PATCH /dns/zones/{id}/records/{rid}` Update a record (content, TTL, steering, enabled, proxied)	读写	`id` integer `rid` integer 请求体: `content` string, `ttl` integer, `weight` integer, `health_check` string, `enabled` boolean, `proxied` boolean	`orbit dns records patch <id> <rid>` `dns_records_patch`
`DELETE /dns/zones/{id}/records/{rid}` Delete a record	读写	`id` integer `rid` integer	`orbit dns records delete <id> <rid>` `dns_records_delete`

继续

相关文档

账户 API 参考

Orbit API 中账户的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

组织 API 参考

Orbit API 中组织的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

服务 API 参考

Orbit API 中服务的全部 15 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

← 全部文档