Tailscale

App · 20 actions

Manage your Tailscale network: approve, rename, tag and remove devices, turn on subnet routes, manage users, invites and auth keys, and set DNS. Start a workflow when a device joins, waits for approval, goes offline or its key is about to expire.

Actions

ActionWhat it does
Approve or revoke deviceApprove a device that is waiting to join your tailnet, or revoke a device's approval so it loses access.
Change user roleGive a user another role, such as Admin or Member.
Create auth keyCreate an auth key that adds devices to your tailnet without anyone signing in on them, such as servers or build agents.
Expire device keyExpire a device's key now.
Get deviceGet one device with every detail: its addresses, tags, routes, key expiry and when it was last online.
Get DNS settingsGet your tailnet's nameservers, search domains and whether MagicDNS is on.
Get policy fileGet your tailnet policy file: its access rules, groups, tag owners and tests.
Invite userInvite someone to join your tailnet with a role.
List devicesList the devices in your tailnet, with their owner, addresses, tags, approval and when each was last online.
List keysList active auth keys and API access tokens, with what each is for and when it expires.
List usersList the people in your tailnet with their role, status, device count and when they were last seen.
Remove deviceRemove a device from your tailnet.
Rename deviceGive a device a new name in your tailnet.
Revoke keyRevoke an auth key or access token so it stops working.
Set device subnet routesTurn on (or off) subnet routes a device offers, such as 192.168.1.0/24, or 0.0.0.0/0 and ::/0 to use it as an exit node.
Set device tagsAdd tags to a device, remove them, or replace them all.
Set DNS nameserversAdd, remove or replace the nameservers every device in your tailnet uses.
Suspend or restore userSuspend a user, so they and their devices lose access to the tailnet, or restore a suspended user.
Turn device key expiry off or onTurn off a device's key expiry, so it never has to sign in again (for servers), or turn it back on.
Withdraw inviteWithdraw an invite nobody has accepted yet, so its link stops working.

Approve or revoke device

Approve a device that is waiting to join your tailnet, or revoke a device's approval so it loses access. Only matters when device approval is turned on.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.
DecisiondecisiontextRequired
Approve lets the device in; revoke shuts it out.One of: approve, revoke (Revoke approval).

Outputs

deviceobject
The device
Example output
{
  "device": {
    "addresses": [
      "100.87.74.78",
      "fd7a:115c:a1e0:ac82:4843:ca90:697d:c36e"
    ],
    "advertisedRoutes": [
      "10.0.0.0/16"
    ],
    "authorized": true,
    "blocksIncomingConnections": false,
    "clientVersion": "v1.80.0",
    "connectedToControl": false,
    "created": "2026-10-01T05:23:30Z",
    "enabledRoutes": [
      "10.0.0.0/16"
    ],
    "expires": "2027-03-30T04:44:05Z",
    "hostname": "pangolin",
    "id": "92960230385",
    "isEphemeral": false,
    "isExternal": false,
    "keyExpiryDisabled": false,
    "lastSeen": "2026-11-05T09:12:00Z",
    "name": "pangolin.tailfe8c.ts.net",
    "nodeId": "n292kg92CNTRL",
    "os": "linux",
    "sshEnabled": false,
    "tags": [
      "tag:server"
    ],
    "updateAvailable": false,
    "user": "amelie@example.com"
  }
}

Change user role

Give a user another role, such as Admin or Member. The token's own user can't change their own role.

Inputs

Usertailscale_user_idtextRequired
The Tailscale user. Pick one, or give their ID from an earlier step.
RoleroletextRequired
The user's new role.One of: member, admin, it-admin (IT admin), network-admin (Network admin), billing-admin (Billing admin), auditor.

Outputs

userobject
The user
Example output
{
  "user": {
    "created": "2026-01-01T05:23:30Z",
    "currentlyConnected": true,
    "deviceCount": 2,
    "displayName": "Amelie Pangolin",
    "id": "uscwcTtzzo11DEVEL",
    "lastSeen": "2026-11-05T09:12:00Z",
    "loginName": "amelie@example.com",
    "profilePicUrl": "",
    "role": "admin",
    "status": "active",
    "tailnetId": "example.com",
    "type": "member"
  }
}

Create auth key

Create an auth key that adds devices to your tailnet without anyone signing in on them, such as servers or build agents. The key is in the result once only, as 'secret'.

Inputs

Descriptiondescriptiontext
What the key is for, up to 50 letters, digits, spaces and dashes.
Reusablereusabletrue/false
Let the key add more than one device.
Ephemeralephemeraltrue/false
Remove devices added with the key automatically once they go offline.
Pre-approvedpreauthorizedtrue/false
Devices added with the key need no approval, even when device approval is on.
Tagstagslist
Tags every device added with the key gets.
Expires after (days)expiry_daysnumber
How long the key works, 1 to 90 days. Defaults to 90.From 1 to 90.

Outputs

keyobject
The new key's details
secrettext
The key itself (tskey-auth-...), shown only once
Example output
{
  "key": {
    "capabilities": {
      "devices": {
        "create": {
          "ephemeral": true,
          "preauthorized": true,
          "reusable": false,
          "tags": [
            "tag:ci"
          ]
        }
      }
    },
    "created": "2026-11-05T09:00:00Z",
    "description": "Lodol build agents",
    "expires": "2026-11-12T09:00:00Z",
    "expirySeconds": 604800,
    "id": "k123456CNTRL",
    "invalid": false,
    "keyType": "auth",
    "revoked": "",
    "scopes": [],
    "tags": [],
    "userId": "uscwcTtzzo11DEVEL"
  },
  "secret": "tskey-auth-kXXXXXCNTRL-XXXXXXXX"
}

Expire device key

Expire a device's key now. The device is disconnected until someone signs in on it again.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.

Outputs

device_idtext
The device
expiredtrue/false
Always true once done
Example output
{
  "device_id": "n292kg92CNTRL",
  "expired": true
}

Get device

Get one device with every detail: its addresses, tags, routes, key expiry and when it was last online.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.

Outputs

deviceobject
The device
Example output
{
  "device": {
    "addresses": [
      "100.87.74.78",
      "fd7a:115c:a1e0:ac82:4843:ca90:697d:c36e"
    ],
    "advertisedRoutes": [
      "10.0.0.0/16"
    ],
    "authorized": true,
    "blocksIncomingConnections": false,
    "clientVersion": "v1.80.0",
    "connectedToControl": false,
    "created": "2026-10-01T05:23:30Z",
    "enabledRoutes": [
      "10.0.0.0/16"
    ],
    "expires": "2027-03-30T04:44:05Z",
    "hostname": "pangolin",
    "id": "92960230385",
    "isEphemeral": false,
    "isExternal": false,
    "keyExpiryDisabled": false,
    "lastSeen": "2026-11-05T09:12:00Z",
    "name": "pangolin.tailfe8c.ts.net",
    "nodeId": "n292kg92CNTRL",
    "os": "linux",
    "sshEnabled": false,
    "tags": [
      "tag:server"
    ],
    "updateAvailable": false,
    "user": "amelie@example.com"
  }
}

Get DNS settings

Get your tailnet's nameservers, search domains and whether MagicDNS is on.

Inputs

None.

Outputs

magic_dnstrue/false
Whether MagicDNS is on
nameserverslist
The global nameservers
search_pathslist
The search domains
Example output
{
  "magic_dns": true,
  "nameservers": [
    "1.1.1.1"
  ],
  "search_paths": [
    "corp.example.com"
  ]
}

Get policy file

Get your tailnet policy file: its access rules, groups, tag owners and tests.

Inputs

None.

Outputs

etagtext
Identifies this version; it changes with every edit
policyobject
The policy file (acls, groups, tagOwners, tests)
Example output
{
  "etag": "\"e0b2816b418\"",
  "policy": {
    "acls": [
      {
        "action": "accept",
        "dst": [
          "*:*"
        ],
        "src": [
          "*"
        ]
      }
    ],
    "tagOwners": {
      "tag:server": [
        "autogroup:admin"
      ]
    }
  }
}

Invite user

Invite someone to join your tailnet with a role. Tailscale emails the invite when an address is given; the result also has a link to share.

Inputs

Emailemailtext
Who to email the invite to. Leave empty to only get a link, which anyone who has it can use.
Roleroletext
The role they get when they join. Defaults to Member.One of: member, admin, it-admin (IT admin), network-admin (Network admin), billing-admin (Billing admin), auditor. Default: member.

Outputs

inviteobject
The invite
Example output
{
  "invite": {
    "email": "jo@example.com",
    "id": "29214",
    "inviteUrl": "https://login.tailscale.com/uinv/abc123",
    "inviterId": 34567,
    "lastEmailSentAt": "2026-11-05T16:23:26Z",
    "role": "member",
    "tailnetId": 12345
  }
}

List devices

List the devices in your tailnet, with their owner, addresses, tags, approval and when each was last online.

Inputs

Tagtagtext
Only devices with this tag, such as tag:server.
Approvalapprovaltext
Only approved devices, or only those waiting.One of: approved (Approved only), pending (Waiting for approval only).
Include every detailinclude_detailstrue/false
Also return each device's subnet routes, posture and client details.

Outputs

countnumber
How many
deviceslist
The devices
Example output
{
  "count": 1,
  "devices": [
    {
      "addresses": [
        "100.87.74.78",
        "fd7a:115c:a1e0:ac82:4843:ca90:697d:c36e"
      ],
      "advertisedRoutes": [
        "10.0.0.0/16"
      ],
      "authorized": true,
      "blocksIncomingConnections": false,
      "clientVersion": "v1.80.0",
      "connectedToControl": false,
      "created": "2026-10-01T05:23:30Z",
      "enabledRoutes": [
        "10.0.0.0/16"
      ],
      "expires": "2027-03-30T04:44:05Z",
      "hostname": "pangolin",
      "id": "92960230385",
      "isEphemeral": false,
      "isExternal": false,
      "keyExpiryDisabled": false,
      "lastSeen": "2026-11-05T09:12:00Z",
      "name": "pangolin.tailfe8c.ts.net",
      "nodeId": "n292kg92CNTRL",
      "os": "linux",
      "sshEnabled": false,
      "tags": [
        "tag:server"
      ],
      "updateAvailable": false,
      "user": "amelie@example.com"
    }
  ]
}

List keys

List active auth keys and API access tokens, with what each is for and when it expires.

Inputs

Everyone's keysinclude_alltrue/false
Include every key in the tailnet, not only the token owner's own.

Outputs

countnumber
How many
keyslist
The keys
Example output
{
  "count": 1,
  "keys": [
    {
      "capabilities": {
        "devices": {
          "create": {
            "ephemeral": true,
            "preauthorized": true,
            "reusable": false,
            "tags": [
              "tag:ci"
            ]
          }
        }
      },
      "created": "2026-11-05T09:00:00Z",
      "description": "Lodol build agents",
      "expires": "2026-11-12T09:00:00Z",
      "expirySeconds": 604800,
      "id": "k123456CNTRL",
      "invalid": false,
      "keyType": "auth",
      "revoked": "",
      "scopes": [],
      "tags": [],
      "userId": "uscwcTtzzo11DEVEL"
    }
  ]
}

List users

List the people in your tailnet with their role, status, device count and when they were last seen.

Inputs

Whouser_typetext
Members, people devices are shared with, or both. Defaults to members.One of: member (Members (default)), shared (People devices are shared with), all (Both). Default: member.
Roleroletext
Only people with this role. Defaults to any role.One of: all (Any role (default)), owner, admin, it-admin (IT admin), network-admin (Network admin), billing-admin (Billing admin), auditor, member. Default: all.

Outputs

countnumber
How many
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "created": "2026-01-01T05:23:30Z",
      "currentlyConnected": true,
      "deviceCount": 2,
      "displayName": "Amelie Pangolin",
      "id": "uscwcTtzzo11DEVEL",
      "lastSeen": "2026-11-05T09:12:00Z",
      "loginName": "amelie@example.com",
      "profilePicUrl": "",
      "role": "member",
      "status": "active",
      "tailnetId": "example.com",
      "type": "member"
    }
  ]
}

Remove device

Remove a device from your tailnet. It has to be added again to reconnect.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.

Outputs

deletedtrue/false
Always true once done
device_idtext
The device removed
Example output
{
  "deleted": true,
  "device_id": "n292kg92CNTRL"
}

Rename device

Give a device a new name in your tailnet. Its MagicDNS name changes at once, so links using the old name stop working.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.
New namenametextRequired
Letters, digits and dashes, such as web-server-1.

Outputs

deviceobject
The device
Example output
{
  "device": {
    "addresses": [
      "100.87.74.78",
      "fd7a:115c:a1e0:ac82:4843:ca90:697d:c36e"
    ],
    "advertisedRoutes": [
      "10.0.0.0/16"
    ],
    "authorized": true,
    "blocksIncomingConnections": false,
    "clientVersion": "v1.80.0",
    "connectedToControl": false,
    "created": "2026-10-01T05:23:30Z",
    "enabledRoutes": [
      "10.0.0.0/16"
    ],
    "expires": "2027-03-30T04:44:05Z",
    "hostname": "web-server-1",
    "id": "92960230385",
    "isEphemeral": false,
    "isExternal": false,
    "keyExpiryDisabled": false,
    "lastSeen": "2026-11-05T09:12:00Z",
    "name": "pangolin.tailfe8c.ts.net",
    "nodeId": "n292kg92CNTRL",
    "os": "linux",
    "sshEnabled": false,
    "tags": [
      "tag:server"
    ],
    "updateAvailable": false,
    "user": "amelie@example.com"
  }
}

Revoke key

Revoke an auth key or access token so it stops working. Devices already added with an auth key stay connected.

Inputs

Keykey_idtextRequired
The key. Pick one, or give its ID from an earlier step.

Outputs

deletedtrue/false
Always true once done
key_idtext
The key revoked
Example output
{
  "deleted": true,
  "key_id": "k123456CNTRL"
}

Set device subnet routes

Turn on (or off) subnet routes a device offers, such as 192.168.1.0/24, or 0.0.0.0/0 and ::/0 to use it as an exit node. A route works only once the device offers it too.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.
RoutesrouteslistRequired
Subnets such as 192.168.1.0/24, one per entry or separated by commas.
Howmodetext
Add to the routes already set, remove from them, or replace them all. Defaults to add.One of: add (Add to the current list), remove (Remove from the current list), replace (Replace the whole list). Default: add.

Outputs

advertised_routeslist
The routes the device offers
changedtrue/false
False if the list was already that way, so nothing was sent
enabled_routeslist
The routes turned on now
Example output
{
  "advertised_routes": [
    "10.0.0.0/16"
  ],
  "changed": true,
  "enabled_routes": [
    "10.0.0.0/16"
  ]
}

Set device tags

Add tags to a device, remove them, or replace them all. A tagged device belongs to its tags rather than to a person, and the policy file decides what each tag can reach.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.
TagstagslistRequired
Tags such as tag:server. A tag must have an owner in the tailnet policy file before a device can carry it.
Howmodetext
Add to the tags already set, remove from them, or replace them all. Defaults to add.One of: add (Add to the current list), remove (Remove from the current list), replace (Replace the whole list). Default: add.

Outputs

changedtrue/false
False if the list was already that way, so nothing was sent
deviceobject
The device, as it is now
tagslist
The device's tags now
Example output
{
  "changed": true,
  "device": {
    "addresses": [
      "100.87.74.78",
      "fd7a:115c:a1e0:ac82:4843:ca90:697d:c36e"
    ],
    "advertisedRoutes": [
      "10.0.0.0/16"
    ],
    "authorized": true,
    "blocksIncomingConnections": false,
    "clientVersion": "v1.80.0",
    "connectedToControl": false,
    "created": "2026-10-01T05:23:30Z",
    "enabledRoutes": [
      "10.0.0.0/16"
    ],
    "expires": "2027-03-30T04:44:05Z",
    "hostname": "pangolin",
    "id": "92960230385",
    "isEphemeral": false,
    "isExternal": false,
    "keyExpiryDisabled": false,
    "lastSeen": "2026-11-05T09:12:00Z",
    "name": "pangolin.tailfe8c.ts.net",
    "nodeId": "n292kg92CNTRL",
    "os": "linux",
    "sshEnabled": false,
    "tags": [
      "tag:server"
    ],
    "updateAvailable": false,
    "user": "amelie@example.com"
  },
  "tags": [
    "tag:server"
  ]
}

Set DNS nameservers

Add, remove or replace the nameservers every device in your tailnet uses. Removing them all turns MagicDNS off.

Inputs

NameserversnameserverslistRequired
IP addresses such as 1.1.1.1, one per entry or separated by commas.
Howmodetext
Add to the nameservers already set, remove from them, or replace them all. Defaults to add.One of: add (Add to the current list), remove (Remove from the current list), replace (Replace the whole list). Default: add.

Outputs

changedtrue/false
False if the list was already that way, so nothing was sent
magic_dnstrue/false
Whether MagicDNS is on
nameserverslist
The nameservers now
Example output
{
  "changed": true,
  "magic_dns": true,
  "nameservers": [
    "1.1.1.1"
  ]
}

Suspend or restore user

Suspend a user, so they and their devices lose access to the tailnet, or restore a suspended user.

Inputs

Usertailscale_user_idtextRequired
The Tailscale user. Pick one, or give their ID from an earlier step.
Suspend or restoreaccesstextRequired
Suspend cuts off access; restore gives it back.One of: suspend, restore.

Outputs

userobject
The user
Example output
{
  "user": {
    "created": "2026-01-01T05:23:30Z",
    "currentlyConnected": true,
    "deviceCount": 2,
    "displayName": "Amelie Pangolin",
    "id": "uscwcTtzzo11DEVEL",
    "lastSeen": "2026-11-05T09:12:00Z",
    "loginName": "amelie@example.com",
    "profilePicUrl": "",
    "role": "member",
    "status": "suspended",
    "tailnetId": "example.com",
    "type": "member"
  }
}

Turn device key expiry off or on

Turn off a device's key expiry, so it never has to sign in again (for servers), or turn it back on.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its ID (nodeId) from an earlier step.
Turn key expiry offkey_expiry_disabledtrue/falseRequired
On: the device's key never expires. Off: it expires on its original date again.

Outputs

deviceobject
The device
Example output
{
  "device": {
    "addresses": [
      "100.87.74.78",
      "fd7a:115c:a1e0:ac82:4843:ca90:697d:c36e"
    ],
    "advertisedRoutes": [
      "10.0.0.0/16"
    ],
    "authorized": true,
    "blocksIncomingConnections": false,
    "clientVersion": "v1.80.0",
    "connectedToControl": false,
    "created": "2026-10-01T05:23:30Z",
    "enabledRoutes": [
      "10.0.0.0/16"
    ],
    "expires": "2027-03-30T04:44:05Z",
    "hostname": "pangolin",
    "id": "92960230385",
    "isEphemeral": false,
    "isExternal": false,
    "keyExpiryDisabled": true,
    "lastSeen": "2026-11-05T09:12:00Z",
    "name": "pangolin.tailfe8c.ts.net",
    "nodeId": "n292kg92CNTRL",
    "os": "linux",
    "sshEnabled": false,
    "tags": [
      "tag:server"
    ],
    "updateAvailable": false,
    "user": "amelie@example.com"
  }
}

Withdraw invite

Withdraw an invite nobody has accepted yet, so its link stops working.

Inputs

Inviteinvite_idtextRequired
The invite. Pick one, or give its ID from 'Invite user'.

Outputs

deletedtrue/false
Always true once done
invite_idtext
The invite withdrawn
Example output
{
  "deleted": true,
  "invite_id": "29214"
}

On this page