You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/tools/tailscale.mdx
+4-29Lines changed: 4 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,35 +10,11 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
10
10
color="#2E2D2D"
11
11
/>
12
12
13
-
## Overview
13
+
## Usage Instructions
14
14
15
-
[Tailscale](https://tailscale.com) is a zero-config mesh VPN built on WireGuard that makes it easy to connect devices, services, and users across any network. The Tailscale block lets you automate network management tasks like device provisioning, access control, route management, and DNS configuration directly from your Sim workflows.
15
+
Interact with the Tailscale API to manage devices, DNS, ACLs, auth keys, users, and routes across your tailnet.
16
16
17
-
## Authentication
18
17
19
-
The Tailscale block uses API key authentication. To get an API key:
20
-
21
-
1. Go to the [Tailscale admin console](https://login.tailscale.com/admin/settings/keys)
22
-
2. Navigate to **Settings > Keys**
23
-
3. Click **Generate API key**
24
-
4. Set an expiry (1-90 days) and copy the key (starts with `tskey-api-`)
25
-
26
-
You must have an **Owner**, **Admin**, **IT admin**, or **Network admin** role to generate API keys.
27
-
28
-
## Tailnet Identifier
29
-
30
-
Every operation requires a **tailnet** parameter. This is typically your organization's domain name (e.g., `example.com`). You can also use `"-"` to refer to your default tailnet.
31
-
32
-
## Common Use Cases
33
-
34
-
-**Device inventory**: List and monitor all devices connected to your network
35
-
-**Automated provisioning**: Create and manage auth keys to pre-authorize new devices
36
-
-**Access control**: Authorize or deauthorize devices, manage device tags for ACL policies
37
-
-**Route management**: View and enable subnet routes for devices acting as subnet routers
38
-
-**DNS management**: Configure nameservers, MagicDNS, and search paths
39
-
-**Key lifecycle**: Create, list, inspect, and revoke auth keys
40
-
-**User auditing**: List all users in the tailnet and their roles
41
-
-**Policy review**: Retrieve the current ACL policy for inspection or backup
42
18
43
19
## Tools
44
20
@@ -100,8 +76,6 @@ Get details of a specific device by ID
100
76
|`blocksIncomingConnections`| boolean | Whether the device blocks incoming connections |
0 commit comments