mirror of
https://github.com/tailscale/tailscale.git
synced 2024-12-01 14:05:39 +00:00
4f4f317174
This change updates the existing api.md TOC links to point at the new publicapi folder/files. It also removes the body of the docs from the file, to avoid the docs becoming out of sync. This change also renames overview.md to readme.md. Updates tailscale/corp#19526 Signed-off-by: Charlotte Brandhorst-Satzkorn <charlotte@tailscale.com>
6.6 KiB
6.6 KiB
Tailscale API
The Tailscale API documentation is located in tailscale/publicapi.
APIs
- 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
- Get device routes:
- Authorize
- Authorize a device:
POST /api/v2/device/{deviceID}/authorized
- Authorize a device:
- Tags
- Update tags:
POST /api/v2/device/{deviceID}/tags
- Update tags:
- Keys
- Update device key:
POST /api/v2/device/{deviceID}/key
- Update device key:
- IP Addresses
- Set device IPv4 address:
POST /api/v2/device/{deviceID}/ip
- Set device IPv4 address:
- 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}
- Get device posture attributes:
- Device invites
- List device invites:
GET /api/v2/device/{deviceID}/device-invites - Create device invites:
POST /api/v2/device/{deviceID}/device-invites
- List device invites:
- 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
- Get policy file:
- Devices
- List tailnet devices:
GET /api/v2/tailnet/{tailnet}/devices
- List 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}
- List tailnet keys:
- DNS
- Nameservers
- Get nameservers:
GET /api/v2/tailnet/{tailnet}/dns/nameservers - Set nameservers:
POST /api/v2/tailnet/{tailnet}/dns/nameservers
- Get nameservers:
- Preferences
- Get DNS preferences:
GET /api/v2/tailnet/{tailnet}/dns/preferences - Set DNS preferences:
POST /api/v2/tailnet/{tailnet}/dns/preferences
- Get DNS preferences:
- Search Paths
- Get search paths:
GET /api/v2/tailnet/{tailnet}/dns/searchpaths - Set search paths:
POST /api/v2/tailnet/{tailnet}/dns/searchpaths
- Get search paths:
- 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
- Get split DNS:
- Nameservers
- User invites
- List user invites:
GET /api/v2/tailnet/{tailnet}/user-invites - Create user invites:
POST /api/v2/tailnet/{tailnet}/user-invites
- List 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
- 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