Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tailscale DNS API

The DNS API from Tailscale — 3 operation(s) for dns.

Tailscale DNS API is one of 7 APIs that Tailscale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DNS. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against a single base URL, https://api.tailscale.com/api/v2.

6 operations 3 paths 0 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://api.tailscale.com/api/v2
Authentication
HTTP Bearer, HTTP Basic
Contact
Resource Areas
1

Authentication & Security 2

Tailscale DNS API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BearerAuth — Tailscale API access token (prefixed "tskey-api-") passed in the Authorization header. Tokens are created in the admin console with 1-90 day expiry, or via OAu…
  • BasicAuth — HTTP Basic Auth with the access token as the username and an empty password.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

DNS 6
GET
/tailnet/{tailnet}/dns/nameservers
Get DNS nameservers
getDnsNameservers 1 param → 200
POST
/tailnet/{tailnet}/dns/nameservers
Set DNS nameservers
setDnsNameservers 1 param → 200
GET
/tailnet/{tailnet}/dns/preferences
Get DNS preferences
getDnsPreferences 1 param → 200
POST
/tailnet/{tailnet}/dns/preferences
Set DNS preferences
setDnsPreferences 1 param → 200
GET
/tailnet/{tailnet}/dns/searchpaths
Get DNS search paths
getDnsSearchPaths 1 param → 200
POST
/tailnet/{tailnet}/dns/searchpaths
Set DNS search paths
setDnsSearchPaths 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tailscale-dns-api-openapi.yml Raw ↑

Other APIs Tailscale publishes across the network.

Tailscale Devices API
Tailscale Invites API
Tailscale Keys API
Tailscale Logging API
Tailscale Policy API
Tailscale Tailnet API