1.1.0 • Published 2 years ago

@4lch4/tailscale-lib v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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/PathHTTP MethodClass & Method/Operation IDDescription
/api/v2/device/:deviceIDGETDevicesRoutes#getDeviceList the details for a device.
/api/v2/device/:deviceIDDELETEDevicesRoutes#deleteDeviceDeletes the device from its Tailnet.
/api/v2/device/:deviceID/routesGETDevicesRoutes#getDeviceRoutesFetch subnet routes that are advertised and enabled for a device
/api/v2/device/:deviceID/routesPOSTDevicesRoutes#setDeviceRoutesSet the subnet routes that are enabled for a device.
/api/v2/device/:deviceID/authorizedPOSTDevicesRoutes#authorizeDeviceAuthorize a device.
/api/v2/device/:deviceID/tagsPOSTDevicesRoutes#setDeviceTagsUpdate tags on a device.
/api/v2/device/:deviceID/keyPOSTDevicesRoutes#updateDeviceKeyUpdate device key.
/api/v2/tailnet/:tailnet/aclGETTailnetsRoutes#getTailnetACLFetch ACL for a Tailnet.
/api/v2/tailnet/:tailnet/aclPOSTTailnetsRoutes#updateTailnetACLSet ACL for a Tailnet.
/api/v2/tailnet/:tailnet/acl/previewPOSTTailnetsRoutes#previewTailnetACLPreview rule matches on an ACL for a resource.
/api/v2/tailnet/:tailnet/acl/validatePOSTTailnetsRoutes#validateTailnetACLRun validation tests against the Tailnet’s active ACL.
/api/v2/tailnet/:tailnet/devicesGETTailnetsRoutes#listTailnetDevicesList the devices for a Tailnet.
/api/v2/tailnet/:tailnet/keysGETTailnetsRoutes#listTailnetKeysList the keys for a Tailnet.
/api/v2/tailnet/:tailnet/keysPOSTTailnetsRoutes#createTailnetKeyCreate a new key for a Tailnet.
/api/v2/tailnet/:tailnet/keys/:keyIDGETTailnetsRoutes#getTailnetKeyGet information for a specific key.
/api/v2/tailnet/:tailnet/keys/:keyIDDELETETailnetsRoutes#deleteTailnetKeyDelete a specific key.
/api/v2/tailnet/:tailnet/dns/nameserversGETTailnetsRoutes#getTailnetNameserversList the DNS nameservers for a Tailnet.
/api/v2/tailnet/:tailnet/dns/nameserversPOSTTailnetsRoutes#updateTailnetNameserversReplaces the list of DNS nameservers for a Tailnet.
/api/v2/tailnet/:tailnet/dns/preferencesGETTailnetsRoutes#getTailnetDNSPreferencesRetrieves the DNS preferences for a Tailnet.
/api/v2/tailnet/:tailnet/dns/preferencesPOSTTailnetsRoutes#updateTailnetDNSPreferencesReplaces the DNS preferences for a Tailnet.
/api/v2/tailnet/:tailnet/dns/searchpathsGETTailnetsRoutes#getTailnetDNSSearchPathsRetrieves the search paths for a Tailnet.
/api/v2/tailnet/:tailnet/dns/searchpathsPOSTTailnetsRoutes#updateTailnetDNSSearchPathsReplaces the search paths for a Tailnet.