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`

Input

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

Output

Parameter	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

`tailscale_get_device`

Input

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

Output

Parameter	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

`tailscale_delete_device`

Input

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

Output

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

`tailscale_authorize_device`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	No description
`authorized`	boolean	Yes	No description

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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	No description
`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	deviceId output from the tool
`tags`	array	Tags set on the device

`tailscale_get_device_routes`

Input

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

Output

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

`tailscale_set_device_routes`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	No description
`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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`deviceId`	string	Yes	No description
`keyExpiryDisabled`	boolean	Yes	No description

Output

Parameter	Type	Description
`success`	boolean	Whether the operation succeeded
`deviceId`	string	deviceId output from the tool
`keyExpiryDisabled`	boolean	Whether key expiry is now disabled

`tailscale_list_dns_nameservers`

Input

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

Output

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

`tailscale_set_dns_nameservers`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`magicDNS`	boolean	Yes	No description

Output

Parameter	Type	Description
`magicDNS`	boolean	Updated MagicDNS status

`tailscale_get_dns_searchpaths`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`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
`result`	array	Updated list of DNS search path domains

`tailscale_list_users`

Input

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

Output

Parameter	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

`tailscale_create_auth_key`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`tailnet`	string	Yes	Tailnet name (e.g., example.com) or "-" for default
`reusable`	boolean	No	No description
`ephemeral`	boolean	No	No description
`preauthorized`	boolean	No	No description
`tags`	string	No	Comma-separated list of tags for devices using this key (e.g., "tag:server,tag:prod")
`description`	string	No	No description
`expirySeconds`	number	No	No description

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
↳ `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

`tailscale_list_auth_keys`

Input

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

Output

Parameter	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

`tailscale_get_auth_key`

Input

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

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
↳ `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

`tailscale_delete_auth_key`

Input

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

Output

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

`tailscale_get_acl`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`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

On this page