|
1 | 1 | > [!IMPORTANT]
|
2 | 2 | > The Tailscale API documentation has moved to https://tailscale.com/api
|
3 |
| -
|
4 |
| -# Tailscale API |
5 |
| - |
6 |
| -The Tailscale API documentation is located in **[tailscale/publicapi](./publicapi/readme.md#tailscale-api)**. |
7 |
| - |
8 |
| -# APIs |
9 |
| - |
10 |
| -**[Overview](./publicapi/readme.md)** |
11 |
| - |
12 |
| -**[Device](./publicapi/device.md#device)** |
13 |
| - |
14 |
| -<a href="device-delete"></a> |
15 |
| -<a href="expire-device-key"></a> |
16 |
| -<a href="device-routes-get"> |
17 |
| -<a href="device-routes-post"></a> |
18 |
| -<a href="#device-authorized-post"></a> |
19 |
| -<a href="device-tags-post"></a> |
20 |
| -<a href="device-key-post"></a> |
21 |
| -<a href="tailnet-acl-get"></a> |
22 |
| - |
23 |
| -- Get a device: [`GET /api/v2/device/{deviceid}`](./publicapi/device.md#get-device) |
24 |
| -- Delete a device: [`DELETE /api/v2/device/{deviceID}`](./publicapi/device.md#delete-device) |
25 |
| -- Expire device key: [`POST /api/v2/device/{deviceID}/expire`](./publicapi/device.md#expire-device-key) |
26 |
| -- [**Routes**](./publicapi/device.md#routes) |
27 |
| - - Get device routes: [`GET /api/v2/device/{deviceID}/routes`](./publicapi/device.md#get-device-routes) |
28 |
| - - Set device routes: [`POST /api/v2/device/{deviceID}/routes`](./publicapi/device.md#set-device-routes) |
29 |
| -- [**Authorize**](./publicapi/device.md#authorize) |
30 |
| - - Authorize a device: [`POST /api/v2/device/{deviceID}/authorized`](./publicapi/device.md#authorize-device) |
31 |
| -- [**Tags**](./publicapi/device.md#tags) |
32 |
| - - Update tags: [`POST /api/v2/device/{deviceID}/tags`](./publicapi/device.md#update-device-tags) |
33 |
| -- [**Keys**](./publicapi/device.md#keys) |
34 |
| - - Update device key: [`POST /api/v2/device/{deviceID}/key`](./publicapi/device.md#update-device-key) |
35 |
| -- [**IP Addresses**](./publicapi/device.md#ip-addresses) |
36 |
| - - Set device IPv4 address: [`POST /api/v2/device/{deviceID}/ip`](./publicapi/device.md#set-device-ipv4-address) |
37 |
| -- [**Device posture attributes**](./publicapi/device.md#device-posture-attributes) |
38 |
| - - Get device posture attributes: [`GET /api/v2/device/{deviceID}/attributes`](./publicapi/device.md#get-device-posture-attributes) |
39 |
| - - Set custom device posture attributes: [`POST /api/v2/device/{deviceID}/attributes/{attributeKey}`](./publicapi/device.md#set-device-posture-attributes) |
40 |
| - - Delete custom device posture attributes: [`DELETE /api/v2/device/{deviceID}/attributes/{attributeKey}`](./publicapi/device.md#delete-custom-device-posture-attributes) |
41 |
| -- [**Device invites**](./publicapi/device.md#invites-to-a-device) |
42 |
| - - List device invites: [`GET /api/v2/device/{deviceID}/device-invites`](./publicapi/device.md#list-device-invites) |
43 |
| - - Create device invites: [`POST /api/v2/device/{deviceID}/device-invites`](./publicapi/device.md#create-device-invites) |
44 |
| - |
45 |
| -**[Tailnet](./publicapi/tailnet.md#tailnet)** |
46 |
| - |
47 |
| -<a href="tailnet-acl-post"></a> |
48 |
| -<a href="tailnet-acl-preview-post"></a> |
49 |
| -<a href="tailnet-acl-validate-post"></a> |
50 |
| -<a href="tailnet-devices"></a> |
51 |
| -<a href="tailnet-keys-get"></a> |
52 |
| -<a href="tailnet-keys-post"></a> |
53 |
| -<a href="tailnet-keys-key-get"></a> |
54 |
| -<a href="tailnet-keys-key-delete"></a> |
55 |
| -<a href="tailnet-dns"></a> |
56 |
| -<a href="tailnet-dns-nameservers-get"></a> |
57 |
| -<a href="tailnet-dns-nameservers-post"></a> |
58 |
| -<a href="tailnet-dns-preferences-get"></a> |
59 |
| -<a href="tailnet-dns-preferences-post"></a> |
60 |
| -<a href="tailnet-dns-searchpaths-get"></a> |
61 |
| -<a href="tailnet-dns-searchpaths-post"></a> |
62 |
| - |
63 |
| -- [**Policy File**](./publicapi/tailnet.md#policy-file) |
64 |
| - - Get policy file: [`GET /api/v2/tailnet/{tailnet}/acl`](./publicapi/tailnet.md#get-policy-file) |
65 |
| - - Update policy file: [`POST /api/v2/tailnet/{tailnet}/acl`](./publicapi/tailnet.md#update-policy-file) |
66 |
| - - Preview rule matches: [`POST /api/v2/tailnet/{tailnet}/acl/preview`](./publicapi/tailnet.md#preview-policy-file-rule-matches) |
67 |
| - - Validate and test policy file: [`POST /api/v2/tailnet/{tailnet}/acl/validate`](./publicapi/tailnet.md#validate-and-test-policy-file) |
68 |
| -- [**Devices**](./publicapi/tailnet.md#devices) |
69 |
| - - List tailnet devices: [`GET /api/v2/tailnet/{tailnet}/devices`](./publicapi/tailnet.md#list-tailnet-devices) |
70 |
| -- [**Keys**](./publicapi/tailnet.md#tailnet-keys) |
71 |
| - - List tailnet keys: [`GET /api/v2/tailnet/{tailnet}/keys`](./publicapi/tailnet.md#list-tailnet-keys) |
72 |
| - - Create an auth key: [`POST /api/v2/tailnet/{tailnet}/keys`](./publicapi/tailnet.md#create-auth-key) |
73 |
| - - Get a key: [`GET /api/v2/tailnet/{tailnet}/keys/{keyid}`](./publicapi/tailnet.md#get-key) |
74 |
| - - Delete a key: [`DELETE /api/v2/tailnet/{tailnet}/keys/{keyid}`](./publicapi/tailnet.md#delete-key) |
75 |
| -- [**DNS**](./publicapi/tailnet.md#dns) |
76 |
| - - [**Nameservers**](./publicapi/tailnet.md#nameservers) |
77 |
| - - Get nameservers: [`GET /api/v2/tailnet/{tailnet}/dns/nameservers`](./publicapi/tailnet.md#get-nameservers) |
78 |
| - - Set nameservers: [`POST /api/v2/tailnet/{tailnet}/dns/nameservers`](./publicapi/tailnet.md#set-nameservers) |
79 |
| - - [**Preferences**](./publicapi/tailnet.md#preferences) |
80 |
| - - Get DNS preferences: [`GET /api/v2/tailnet/{tailnet}/dns/preferences`](./publicapi/tailnet.md#get-dns-preferences) |
81 |
| - - Set DNS preferences: [`POST /api/v2/tailnet/{tailnet}/dns/preferences`](./publicapi/tailnet.md#set-dns-preferences) |
82 |
| - - [**Search Paths**](./publicapi/tailnet.md#search-paths) |
83 |
| - - Get search paths: [`GET /api/v2/tailnet/{tailnet}/dns/searchpaths`](./publicapi/tailnet.md#get-search-paths) |
84 |
| - - Set search paths: [`POST /api/v2/tailnet/{tailnet}/dns/searchpaths`](./publicapi/tailnet.md#set-search-paths) |
85 |
| - - [**Split DNS**](./publicapi/tailnet.md#split-dns) |
86 |
| - - Get split DNS: [`GET /api/v2/tailnet/{tailnet}/dns/split-dns`](./publicapi/tailnet.md#get-split-dns) |
87 |
| - - Update split DNS: [`PATCH /api/v2/tailnet/{tailnet}/dns/split-dns`](./publicapi/tailnet.md#update-split-dns) |
88 |
| - - Set split DNS: [`PUT /api/v2/tailnet/{tailnet}/dns/split-dns`](./publicapi/tailnet.md#set-split-dns) |
89 |
| -- [**User invites**](./publicapi/tailnet.md#tailnet-user-invites) |
90 |
| - - List user invites: [`GET /api/v2/tailnet/{tailnet}/user-invites`](./publicapi/tailnet.md#list-user-invites) |
91 |
| - - Create user invites: [`POST /api/v2/tailnet/{tailnet}/user-invites`](./publicapi/tailnet.md#create-user-invites) |
92 |
| - |
93 |
| -**[User invites](./publicapi/userinvites.md#user-invites)** |
94 |
| - |
95 |
| -- Get user invite: [`GET /api/v2/user-invites/{userInviteId}`](./publicapi/userinvites.md#get-user-invite) |
96 |
| -- Delete user invite: [`DELETE /api/v2/user-invites/{userInviteId}`](./publicapi/userinvites.md#delete-user-invite) |
97 |
| -- Resend user invite (by email): [`POST /api/v2/user-invites/{userInviteId}/resend`](#resend-user-invite) |
98 |
| - |
99 |
| -**[Device invites](./publicapi/deviceinvites.md#device-invites)** |
100 |
| - |
101 |
| -- Get device invite: [`GET /api/v2/device-invites/{deviceInviteId}`](./publicapi/deviceinvites.md#get-device-invite) |
102 |
| -- Delete device invite: [`DELETE /api/v2/device-invites/{deviceInviteId}`](./publicapi/deviceinvites.md#delete-device-invite) |
103 |
| -- Resend device invite (by email): [`POST /api/v2/device-invites/{deviceInviteId}/resend`](./publicapi/deviceinvites.md#resend-device-invite) |
104 |
| -- Accept device invite [`POST /api/v2/device-invites/-/accept`](#accept-device-invite) |
0 commit comments