tailscale/api.md

Tailscale API

The Tailscale API documentation is located in tailscale/publicapi.

APIs

Overview

Device

• Get a device: GET /api/v2/device/{deviceid}
• Delete a device: DELETE /api/v2/device/{deviceID}
• Expire device key: POST /api/v2/device/{deviceID}/expire
• Routes
  • Get device routes: GET /api/v2/device/{deviceID}/routes
  • Set device routes: POST /api/v2/device/{deviceID}/routes
• Authorize
  • Authorize a device: POST /api/v2/device/{deviceID}/authorized
• Tags
  • Update tags: POST /api/v2/device/{deviceID}/tags
• Keys
  • Update device key: POST /api/v2/device/{deviceID}/key
• IP Addresses
  • Set device IPv4 address: POST /api/v2/device/{deviceID}/ip
• Device posture attributes
  • Get device posture attributes: GET /api/v2/device/{deviceID}/attributes
  • Set custom device posture attributes: POST /api/v2/device/{deviceID}/attributes/{attributeKey}
  • Delete custom device posture attributes: DELETE /api/v2/device/{deviceID}/attributes/{attributeKey}
• Device invites
  • List device invites: GET /api/v2/device/{deviceID}/device-invites
  • Create device invites: POST /api/v2/device/{deviceID}/device-invites

Tailnet

• Policy File
  • Get policy file: GET /api/v2/tailnet/{tailnet}/acl
  • Update policy file: POST /api/v2/tailnet/{tailnet}/acl
  • Preview rule matches: POST /api/v2/tailnet/{tailnet}/acl/preview
  • Validate and test policy file: POST /api/v2/tailnet/{tailnet}/acl/validate
• Devices
  • List tailnet devices: GET /api/v2/tailnet/{tailnet}/devices
• Keys
  • List tailnet keys: GET /api/v2/tailnet/{tailnet}/keys
  • Create an auth key: POST /api/v2/tailnet/{tailnet}/keys
  • Get a key: GET /api/v2/tailnet/{tailnet}/keys/{keyid}
  • Delete a key: DELETE /api/v2/tailnet/{tailnet}/keys/{keyid}
• DNS
  • Nameservers
  • Get nameservers: GET /api/v2/tailnet/{tailnet}/dns/nameservers
  • Set nameservers: POST /api/v2/tailnet/{tailnet}/dns/nameservers
  • Preferences
  • Get DNS preferences: GET /api/v2/tailnet/{tailnet}/dns/preferences
  • Set DNS preferences: POST /api/v2/tailnet/{tailnet}/dns/preferences
  • Search Paths
  • Get search paths: GET /api/v2/tailnet/{tailnet}/dns/searchpaths
  • Set search paths: POST /api/v2/tailnet/{tailnet}/dns/searchpaths
  • Split DNS
  • Get split DNS: GET /api/v2/tailnet/{tailnet}/dns/split-dns
  • Update split DNS: PATCH /api/v2/tailnet/{tailnet}/dns/split-dns
  • Set split DNS: PUT /api/v2/tailnet/{tailnet}/dns/split-dns
• User invites
  • List user invites: GET /api/v2/tailnet/{tailnet}/user-invites
  • Create user invites: POST /api/v2/tailnet/{tailnet}/user-invites

User invites

• Get user invite: GET /api/v2/user-invites/{userInviteId}
• Delete user invite: DELETE /api/v2/user-invites/{userInviteId}
• Resend user invite (by email): POST /api/v2/user-invites/{userInviteId}/resend

Device invites

• Get device invite: GET /api/v2/device-invites/{deviceInviteId}
• Delete device invite: DELETE /api/v2/device-invites/{deviceInviteId}
• Resend device invite (by email): POST /api/v2/device-invites/{deviceInviteId}/resend
• Accept device invite POST /api/v2/device-invites/-/accept