Interact with the Tailscale API to manage devices, DNS, ACLs, auth keys, users, and routes across your tailnet.
List all devices in the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
devices | array | List of devices in the tailnet |
↳ id | string | Device ID |
↳ name | string | Device name |
↳ hostname | string | Device hostname |
↳ user | string | Associated user |
↳ os | string | Operating system |
↳ clientVersion | string | Tailscale client version |
↳ addresses | array | Tailscale IP addresses |
↳ tags | array | Device tags |
↳ authorized | boolean | Whether the device is authorized |
↳ blocksIncomingConnections | boolean | Whether the device blocks incoming connections |
↳ lastSeen | string | Last seen timestamp |
↳ created | string | Creation timestamp |
count | number | Total number of devices |
Get details of a specific device by ID
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID |
| Paramètre | Type | Description |
|---|
id | string | Device ID |
name | string | Device name |
hostname | string | Device hostname |
user | string | Associated user |
os | string | Operating system |
clientVersion | string | Tailscale client version |
addresses | array | Tailscale IP addresses |
tags | array | Device tags |
authorized | boolean | Whether the device is authorized |
blocksIncomingConnections | boolean | Whether the device blocks incoming connections |
lastSeen | string | Last seen timestamp |
created | string | Creation timestamp |
isExternal | boolean | Whether the device is external |
updateAvailable | boolean | Whether an update is available |
machineKey | string | Machine key |
nodeKey | string | Node key |
Remove a device from the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID to delete |
| Paramètre | Type | Description |
|---|
success | boolean | Whether the device was successfully deleted |
deviceId | string | ID of the deleted device |
Authorize or deauthorize a device on the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID to authorize |
authorized | boolean | Oui | Whether to authorize (true) or deauthorize (false) the device |
| Paramètre | Type | Description |
|---|
success | boolean | Whether the operation succeeded |
deviceId | string | Device ID |
authorized | boolean | Authorization status after the operation |
Set tags on a device in the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID |
tags | string | Oui | Comma-separated list of tags (e.g., "tag:server,tag:production") |
| Paramètre | Type | Description |
|---|
success | boolean | Whether the tags were successfully set |
deviceId | string | Device ID |
tags | array | Tags set on the device |
Get the subnet routes for a device
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID |
| Paramètre | Type | Description |
|---|
advertisedRoutes | array | Subnet routes the device is advertising |
enabledRoutes | array | Subnet routes that are approved/enabled |
Set the enabled subnet routes for a device
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID |
routes | string | Oui | Comma-separated list of subnet routes to enable (e.g., "10.0.0.0/24,192.168.1.0/24") |
| Paramètre | Type | Description |
|---|
advertisedRoutes | array | Subnet routes the device is advertising |
enabledRoutes | array | Subnet routes that are now enabled |
Enable or disable key expiry on a device
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
deviceId | string | Oui | Device ID |
keyExpiryDisabled | boolean | Oui | Whether to disable key expiry (true) or enable it (false) |
| Paramètre | Type | Description |
|---|
success | boolean | Whether the operation succeeded |
deviceId | string | Device ID |
keyExpiryDisabled | boolean | Whether key expiry is now disabled |
Get the DNS nameservers configured for the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
dns | array | List of DNS nameserver addresses |
magicDNS | boolean | Whether MagicDNS is enabled |
Set the DNS nameservers for the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
dns | string | Oui | Comma-separated list of DNS nameserver IP addresses (e.g., "8.8.8.8,8.8.4.4") |
| Paramètre | Type | Description |
|---|
dns | array | Updated list of DNS nameserver addresses |
magicDNS | boolean | Whether MagicDNS is enabled |
Get the DNS preferences for the tailnet including MagicDNS status
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
magicDNS | boolean | Whether MagicDNS is enabled |
Set DNS preferences for the tailnet (enable/disable MagicDNS)
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
magicDNS | boolean | Oui | Whether to enable (true) or disable (false) MagicDNS |
| Paramètre | Type | Description |
|---|
magicDNS | boolean | Updated MagicDNS status |
Get the DNS search paths configured for the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
searchPaths | array | List of DNS search path domains |
Set the DNS search paths for the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
searchPaths | string | Oui | Comma-separated list of DNS search path domains (e.g., "corp.example.com,internal.example.com") |
| Paramètre | Type | Description |
|---|
searchPaths | array | Updated list of DNS search path domains |
List all users in the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
users | array | List of users in the tailnet |
↳ id | string | User ID |
↳ displayName | string | Display name |
↳ loginName | string | Login name / email |
↳ profilePicURL | string | Profile picture URL |
↳ role | string | User role (owner, admin, member, etc.) |
↳ status | string | User status (active, suspended, etc.) |
↳ type | string | User type (member, shared, tagged) |
↳ created | string | Creation timestamp |
↳ lastSeen | string | Last seen timestamp |
↳ deviceCount | number | Number of devices owned by user |
count | number | Total number of users |
Create a new auth key for the tailnet to pre-authorize devices
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
reusable | boolean | Non | Whether the key can be used more than once |
ephemeral | boolean | Non | Whether devices authenticated with this key are ephemeral |
preauthorized | boolean | Non | Whether devices are pre-authorized (skip manual approval) |
tags | string | Non | Comma-separated list of tags for devices using this key (e.g., "tag:server,tag:prod") |
description | string | Non | Description for the auth key |
expirySeconds | number | Non | Key expiry time in seconds (default: 90 days) |
| Paramètre | Type | Description |
|---|
id | string | Auth key ID |
key | string | The auth key value (only shown once at creation) |
description | string | Key description |
created | string | Creation timestamp |
expires | string | Expiration timestamp |
revoked | string | Revocation timestamp (empty if not revoked) |
capabilities | object | Key capabilities |
↳ reusable | boolean | Whether the key is reusable |
↳ ephemeral | boolean | Whether devices are ephemeral |
↳ preauthorized | boolean | Whether devices are pre-authorized |
↳ tags | array | Tags applied to devices using this key |
List all auth keys in the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
keys | array | List of auth keys |
↳ id | string | Auth key ID |
↳ description | string | Key description |
↳ created | string | Creation timestamp |
↳ expires | string | Expiration timestamp |
↳ revoked | string | Revocation timestamp |
↳ capabilities | object | Key capabilities |
↳ reusable | boolean | Whether the key is reusable |
↳ ephemeral | boolean | Whether devices are ephemeral |
↳ preauthorized | boolean | Whether devices are pre-authorized |
↳ tags | array | Tags applied to devices |
count | number | Total number of auth keys |
Get details of a specific auth key
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
keyId | string | Oui | Auth key ID |
| Paramètre | Type | Description |
|---|
id | string | Auth key ID |
description | string | Key description |
created | string | Creation timestamp |
expires | string | Expiration timestamp |
revoked | string | Revocation timestamp |
capabilities | object | Key capabilities |
↳ reusable | boolean | Whether the key is reusable |
↳ ephemeral | boolean | Whether devices are ephemeral |
↳ preauthorized | boolean | Whether devices are pre-authorized |
↳ tags | array | Tags applied to devices using this key |
Revoke and delete an auth key
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
keyId | string | Oui | Auth key ID to delete |
| Paramètre | Type | Description |
|---|
success | boolean | Whether the auth key was successfully deleted |
keyId | string | ID of the deleted auth key |
Get the current ACL policy for the tailnet
| Paramètre | Type | Obligatoire | Description |
|---|
apiKey | string | Oui | Tailscale API key |
tailnet | string | Oui | Tailnet name (e.g., example.com) or "-" for default |
| Paramètre | Type | Description |
|---|
acl | string | ACL policy as JSON string |
etag | string | ETag for the current ACL version (use with If-Match header for updates) |
