Tailscale

Usage Instructions

Interact with the Tailscale API to manage devices, DNS, ACLs, auth keys, users, and routes across your tailnet.

Tools

`tailscale_list_devices`

List all devices in the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`devices`	array	List of devices in the tailnet
`count`	number	Total number of devices

`tailscale_get_device`

Get details of a specific device by ID

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID

Output

Parameter	Type	Description
`id`	string	Legacy device ID
`nodeId`	string	Preferred 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
`keyExpiryDisabled`	boolean	Whether the device key is exempt from expiring
`expires`	string	The device's auth key expiration timestamp
`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

`tailscale_delete_device`

Remove a device from the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID to delete

Output

Parameter	Type	Description
`success`	boolean	Whether the device was successfully deleted
`deviceId`	string	ID of the deleted device

`tailscale_authorize_device`

Authorize or deauthorize a device on the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID to authorize
`authorized`	boolean	Yes	Whether to authorize (true) or deauthorize (false) the device

Output

Parameter	Type	Description
`success`	boolean	Whether the operation succeeded
`deviceId`	string	Device ID
`authorized`	boolean	Authorization status after the operation

`tailscale_set_device_tags`

Set tags on a device in the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID
`tags`	string	Yes	Comma-separated list of tags (e.g., "tag:server,tag:production")

Output

Parameter	Type	Description
`success`	boolean	Whether the tags were successfully set
`deviceId`	string	Device ID
`tags`	array	Tags set on the device

`tailscale_get_device_routes`

Get the subnet routes for a device

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID

Output

Parameter	Type	Description
`advertisedRoutes`	array	Subnet routes the device is advertising
`enabledRoutes`	array	Subnet routes that are approved/enabled

`tailscale_set_device_routes`

Set the enabled subnet routes for a device

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID
`routes`	string	Yes	Comma-separated list of subnet routes to enable (e.g., "10.0.0.0/24,192.168.1.0/24")

Output

Parameter	Type	Description
`advertisedRoutes`	array	Subnet routes the device is advertising
`enabledRoutes`	array	Subnet routes that are now enabled

`tailscale_update_device_key`

Enable or disable key expiry on a device

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID
`keyExpiryDisabled`	boolean	Yes	Whether to disable key expiry (true) or enable it (false)

Output

Parameter	Type	Description
`success`	boolean	Whether the operation succeeded
`deviceId`	string	Device ID
`keyExpiryDisabled`	boolean	Whether key expiry is now disabled

`tailscale_expire_device_key`

Immediately expire a device's node key, requiring it to re-authenticate before it can reconnect to the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	Device ID to expire the key for

Output

Parameter	Type	Description
`success`	boolean	Whether the device's key was successfully expired
`deviceId`	string	Device ID

`tailscale_list_dns_nameservers`

Get the DNS nameservers configured for the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`dns`	array	List of DNS nameserver addresses

`tailscale_set_dns_nameservers`

Set the DNS nameservers for the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`dns`	string	Yes	Comma-separated list of DNS nameserver IP addresses (e.g., "8.8.8.8,8.8.4.4")

Output

Parameter	Type	Description
`dns`	array	Updated list of DNS nameserver addresses
`magicDNS`	boolean	Whether MagicDNS is enabled

`tailscale_get_dns_preferences`

Get the DNS preferences for the tailnet including MagicDNS status

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`magicDNS`	boolean	Whether MagicDNS is enabled

`tailscale_set_dns_preferences`

Set DNS preferences for the tailnet (enable/disable MagicDNS)

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`magicDNS`	boolean	Yes	Whether to enable (true) or disable (false) MagicDNS

Output

Parameter	Type	Description
`magicDNS`	boolean	Updated MagicDNS status

`tailscale_get_dns_searchpaths`

Get the DNS search paths configured for the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`searchPaths`	array	List of DNS search path domains

`tailscale_set_dns_searchpaths`

Set the DNS search paths for the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`searchPaths`	string	Yes	Comma-separated list of DNS search path domains (e.g., "corp.example.com,internal.example.com")

Output

Parameter	Type	Description
`searchPaths`	array	Updated list of DNS search path domains

`tailscale_list_users`

List all users in the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`users`	array	List of users in the tailnet
`count`	number	Total number of users

`tailscale_suspend_user`

Suspend a user's access to the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`userId`	string	Yes	User ID to suspend

Output

Parameter	Type	Description
`success`	boolean	Whether the user was successfully suspended
`userId`	string	ID of the suspended user

`tailscale_delete_user`

Delete a user from the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`userId`	string	Yes	User ID to delete

Output

Parameter	Type	Description
`success`	boolean	Whether the user was successfully deleted
`userId`	string	ID of the deleted user

`tailscale_create_auth_key`

Create a new auth key for the tailnet to pre-authorize devices

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`reusable`	boolean	No	Whether the key can be used more than once
`ephemeral`	boolean	No	Whether devices authenticated with this key are ephemeral
`preauthorized`	boolean	No	Whether devices are pre-authorized (skip manual approval)
`tags`	string	No	Comma-separated list of tags for devices using this key (e.g., "tag:server,tag:prod")
`description`	string	No	Description for the auth key
`expirySeconds`	number	No	Key expiry time in seconds (default: 90 days)

Output

Parameter	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

`tailscale_list_auth_keys`

List all auth keys in the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`keys`	array	List of auth keys
`count`	number	Total number of auth keys

`tailscale_get_auth_key`

Get details of a specific auth key

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`keyId`	string	Yes	Auth key ID

Output

Parameter	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

`tailscale_delete_auth_key`

Revoke and delete an auth key

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`keyId`	string	Yes	Auth key ID to delete

Output

Parameter	Type	Description
`success`	boolean	Whether the auth key was successfully deleted
`keyId`	string	ID of the deleted auth key

`tailscale_get_acl`

Get the current ACL policy for the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default

Output

Parameter	Type	Description
`acl`	string	ACL policy as JSON string
`etag`	string	ETag for the current ACL version (use with If-Match header for updates)

`tailscale_set_acl`

Replace the ACL policy file for the tailnet

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Tailscale API key
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`acl`	string	Yes	The new ACL policy file, as a JSON string
`ifMatch`	string	No	ETag from a prior Get ACL call to avoid overwriting concurrent updates. Use "ts-default" to only replace an untouched default policy file.

Output

Parameter	Type	Description
`acl`	string	Updated ACL policy as JSON string
`etag`	string	ETag for the new ACL version (use with If-Match header for future updates)

Notes

Category: tools
Type: tailscale

Tailscale

On this page