Tailscale-Lib

This repository/package is a wrapper library for interacting with the Tailscale API. It's written in TypeScript and published to the NPM registry and GitHub Package Repository.

ToDo

The following table lists all the routes/paths, and the associated HTTP method, along with the class & method to use to call the route/path.

| Route/Path | HTTP Method | Class & Method/Operation ID | Description | | ------------------------------------------ | ----------- | ----------------------------------------------- | ---------------------------------------------------------------- | | /api/v2/device/:deviceID | GET | DevicesRoutes#getDevice | List the details for a device. | | /api/v2/device/:deviceID | DELETE | DevicesRoutes#deleteDevice | Deletes the device from its Tailnet. | | /api/v2/device/:deviceID/routes | GET | DevicesRoutes#getDeviceRoutes | Fetch subnet routes that are advertised and enabled for a device | | /api/v2/device/:deviceID/routes | POST | DevicesRoutes#setDeviceRoutes | Set the subnet routes that are enabled for a device. | | /api/v2/device/:deviceID/authorized | POST | DevicesRoutes#authorizeDevice | Authorize a device. | | /api/v2/device/:deviceID/tags | POST | DevicesRoutes#setDeviceTags | Update tags on a device. | | /api/v2/device/:deviceID/key | POST | DevicesRoutes#updateDeviceKey | Update device key. | | /api/v2/tailnet/:tailnet/acl | GET | TailnetsRoutes#getTailnetACL | Fetch ACL for a Tailnet. | | /api/v2/tailnet/:tailnet/acl | POST | TailnetsRoutes#updateTailnetACL | Set ACL for a Tailnet. | | /api/v2/tailnet/:tailnet/acl/preview | POST | TailnetsRoutes#previewTailnetACL | Preview rule matches on an ACL for a resource. | | /api/v2/tailnet/:tailnet/acl/validate | POST | TailnetsRoutes#validateTailnetACL | Run validation tests against the Tailnet’s active ACL. | | /api/v2/tailnet/:tailnet/devices | GET | TailnetsRoutes#listTailnetDevices | List the devices for a Tailnet. | | /api/v2/tailnet/:tailnet/keys | GET | TailnetsRoutes#listTailnetKeys | List the keys for a Tailnet. | | /api/v2/tailnet/:tailnet/keys | POST | TailnetsRoutes#createTailnetKey | Create a new key for a Tailnet. | | /api/v2/tailnet/:tailnet/keys/:keyID | GET | TailnetsRoutes#getTailnetKey | Get information for a specific key. | | /api/v2/tailnet/:tailnet/keys/:keyID | DELETE | TailnetsRoutes#deleteTailnetKey | Delete a specific key. | | /api/v2/tailnet/:tailnet/dns/nameservers | GET | TailnetsRoutes#getTailnetNameservers | List the DNS nameservers for a Tailnet. | | /api/v2/tailnet/:tailnet/dns/nameservers | POST | TailnetsRoutes#updateTailnetNameservers | Replaces the list of DNS nameservers for a Tailnet. | | /api/v2/tailnet/:tailnet/dns/preferences | GET | TailnetsRoutes#getTailnetDNSPreferences | Retrieves the DNS preferences for a Tailnet. | | /api/v2/tailnet/:tailnet/dns/preferences | POST | TailnetsRoutes#updateTailnetDNSPreferences | Replaces the DNS preferences for a Tailnet. | | /api/v2/tailnet/:tailnet/dns/searchpaths | GET | TailnetsRoutes#getTailnetDNSSearchPaths | Retrieves the search paths for a Tailnet. | | /api/v2/tailnet/:tailnet/dns/searchpaths | POST | TailnetsRoutes#updateTailnetDNSSearchPaths | Replaces the search paths for a Tailnet. |