tailscale

Commit Graph

Author	SHA1	Message	Date
Mario Minardi	124ff3b034	{api.md,publicapi}: remove old API docs (#13468 ) Now that we have our API docs hosted at https://tailscale.com/api we can remove the previous (and now outdated) markdown based docs. The top level api.md has been left with the only content being the redirect to the new docs. Updates #cleanup Signed-off-by: Mario Minardi <mario@tailscale.com>	2 months ago
Mario Minardi	041733d3d1	publicapi: add note that API docs have moved to existing docs files (#12770 ) Add note that API docs have moved to `https://tailscale.com/api` to the top of existing API docs markdown files. Updates https://github.com/tailscale/corp/issues/1301 Signed-off-by: Mario Minardi <mario@tailscale.com>	4 months ago
Charlotte Brandhorst-Satzkorn	4f4f317174	api.md: direct TOC links to new publicapi docs location This change updates the existing api.md TOC links to point at the new publicapi folder/files. It also removes the body of the docs from the file, to avoid the docs becoming out of sync. This change also renames overview.md to readme.md. Updates tailscale/corp#19526 Signed-off-by: Charlotte Brandhorst-Satzkorn <charlotte@tailscale.com>	6 months ago
Sonia Appasamy	89947606b2	api.md: document device invite apis Updates tailscale/corp#18153 Signed-off-by: Sonia Appasamy <sonia@tailscale.com>	6 months ago
Sonia Appasamy	b094e8c925	api.md: document user invite apis Updates tailscale/corp#18153 Signed-off-by: Sonia Appasamy <sonia@tailscale.com>	6 months ago
Sonia Appasamy	8130656780	api.md: remove extraneous commas in json examples Updates #cleanup Signed-off-by: Sonia Appasamy <sonia@tailscale.com>	7 months ago
Mario Minardi	ec04c677c0	api.md: add documentation for new split DNS endpoints (#11922 ) Add documentation for GET/PATCH/PUT `api/v2/tailnet/<ID>/dns/split-dns`. These endpoints allow for reading, partially updating, and replacing the split DNS settings for a given tailnet. Updates https://github.com/tailscale/corp/issues/19483 Signed-off-by: Mario Minardi <mario@tailscale.com>	7 months ago
Mario Minardi	74c399483c	api.md: explicitly set content-type headers in POST CURL examples (#11916 ) Explicitly set `-H "Content-Type: application/json"` in CURL examples for POST endpoints as the default content type used by CURL is otherwise `application/x-www-form-urlencoded` and these endpoints expect JSON data. Updates https://github.com/tailscale/tailscale/issues/11914 Signed-off-by: Mario Minardi <mario@tailscale.com>	7 months ago
Kristoffer Dalby	1e6cdb7d86	api.md: fix missing links after move of device posture Updates tailscale/corp#18572 Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>	7 months ago
Kristoffer Dalby	9779eb6dba	api.md: move device posture api to api.md Updates tailscale/corp#18572 Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>	7 months ago
Mario Minardi	68d9e49a5b	api.md: add missing backtick to GET searchpaths doc (#11459 ) Add missing backtick to GET searchpaths api documentation. Updates #cleanup Signed-off-by: Mario Minardi <mario@tailscale.com>	8 months ago
Will Norris	349799a1ba	api.md: format API docs with prettier Mostly inconsequential minor fixes for consistency. A couple of changes to actual JSON examples, but all still very readable, so I think it's fine. Updates #cleanup Signed-off-by: Will Norris <will@tailscale.com>	8 months ago
Will Norris	4d747c1833	api.md: document device expiration endpoint This was originally built for testing node expiration flows, but is also useful for customers to force device re-auth without actually deleting the device from the tailnet. Updates tailscale/corp#18408 Signed-off-by: Will Norris <will@tailscale.com>	8 months ago
David Crawshaw	f815d66a88	api.md: add docs for setting an IP address Updates tailscale/corp#16453 Signed-off-by: David Crawshaw <crawshaw@tailscale.com>	11 months ago
Paul Scott	65f2d32300	api.md: add device.postureIdentity field Updates tailscale/corp#15445 Signed-off-by: Paul Scott <paul@tailscale.com>	11 months ago
Brad Fitzpatrick	b7988b3825	api.md: remove clientConnectivity.derp field We don't actually send this. It's always been empty. Updates tailscale/corp#13400 Change-Id: I99b3d7a355fca17d2159bf81ede5be4ddd4b9dc9 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	1 year ago
Anton Tolchanov	75dbd71f49	api.md: document the `invalid` field in Get Key API response Updates tailscale/terraform-provider-tailscale#144 Signed-off-by: Anton Tolchanov <anton@tailscale.com>	1 year ago
tinku-tailscale	aa37be70cf	api.md: update device authorize API docs to allow for deauth (#8728 ) Signed-off-by: tinku-tailscale <139132124+tinku-tailscale@users.noreply.github.com>	1 year ago
Jenny Zhang	907c56c200	api.md: add documentation to API endpoint about SCIM group warnings Updates #8645 Signed-off-by: Jenny Zhang <jz@tailscale.com>	1 year ago
Brad Fitzpatrick	a874f1afd8	all: adjust case of "IPv4" and "IPv6" Updates #docs Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	1 year ago
phirework	2a9817da39	api.md: add info for key description (#8429 ) Updates tailscale/corp#7773 Signed-off-by: Jenny Zhang <jz@tailscale.com>	1 year ago
salman aljammaz	745ee97973	api.md: update device authorized API docs to allow for deauth (#8162 ) The authorize device API (/api/v2/device/{deviceID}/authorized) will soon allow device deauthorisation. Fixes corp#10160. Signed-off-by: salman <salman@tailscale.com>	2 years ago
Will Norris	4ecc7fdf5f	api.md: update example auth key value example was missing the "-auth" type in the key prefix, which all new keys now contain. Also update key ID to match the full key, and fix indenting of closing braces. Signed-off-by: Will Norris <will@tailscale.com>	2 years ago
Julia at Tailscale	ef6f66bb9a	api.md: refresh of API docs Update API documentation to include explanation of resources, a cleaner and more consistent structure, updated terminology, and fixes to a few errors and omissions. Signed-off-by: Julia Stein <julia@tailscale.com> Signed-off-by: Will Norris <will@tailscale.com> Co-authored-by: Will Norris <will@tailscale.com>	2 years ago
Julia Stein	3f16dec1bb	api.md: change "admin panel" to "admin console" Signed-off-by: Julia Stein <julia@tailscale.com>	2 years ago
Anton Tolchanov	d6dbefaa91	api.md: lowercase ACL field names Making this match https://tailscale.com/kb/1018/acls Signed-off-by: Anton Tolchanov <anton@tailscale.com>	2 years ago
Anton Tolchanov	71c0e8d428	api.md: update documentation for the "set ACL" endpoint This documents the `If-Match: ts-default` header that can be set to only overwrite the default ACL contents, and also briefly mentions a few of the new top-level ACL fields. Updates tailscale/terraform-provider-tailscale#182 Signed-off-by: Anton Tolchanov <anton@tailscale.com>	2 years ago
Mihai Parparita	847a8cf917	api.md: make it clearer where to get the tailnet name in API calls We added the tailnet organization name to to the settings page with tailscale/corp#6977, but the docs were not updated to reflect this. We later also changed "tailnet name" to refer to the MagicDNS hostname (tailscale/corp#7537), which further confuses things (see https://stackoverflow.com/questions/74132318). Make it slightly clearer what is the expected value for tailnet names in API calls and how to get it. Signed-off-by: Mihai Parparita <mihai@tailscale.com>	2 years ago
Maisem Ali	d0b7a44840	api.md: add expirySeconds as parameter to post Tailnet keys Updates #4570 Signed-off-by: Maisem Ali <maisem@tailscale.com>	2 years ago
Will Norris	d05dd41bc1	api.md: document using '-' value as default tailnet Signed-off-by: Will Norris <will@tailscale.com>	2 years ago
Logan Saso	f7a36dfeb1	api.md: added missing quote to POST DNS Searchpaths request body example Signed-off-by: Logan Saso <logansaso@gmail.com>	2 years ago
Denton Gentry	53f6c3f9f2	api.md: document preauthorized and tags fields Updates https://github.com/tailscale/tailscale/issues/2120 Updates https://github.com/tailscale/tailscale/issues/4571 Updates https://github.com/tailscale/tailscale/issues/1369 Signed-off-by: Denton Gentry <dgentry@tailscale.com>	3 years ago
Brad Fitzpatrick	46cb9d98a3	api.md: update GET tailnet key detail docs to show preauthorized, tags Fixes #4571 Change-Id: If81471d0d8cb2f659736991ad8612aed2efc174e Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	3 years ago
Brad Fitzpatrick	deb56f276e	Revert "api: document preauthorized auth keys" This reverts commit `dd6472d4e8`. Reason: it appears I was just really really wrong or confused. We added it to the old internal API used by the website instead, not to the "v2" API. Updates #2120 Updates #4571 Change-Id: I744a72b9193aafa7b526fd760add52148a377e83 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	3 years ago
Walter Poupore	71d401cc4e	api.md: remove descriptions from TOC (#4561 )	3 years ago
Brad Fitzpatrick	488e63979e	api.md: document new ACL validate mode Updates tailscale/corp#4932 Change-Id: Ie176ee79595c3b56d3376f1d81a441f9272e6ed4 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	3 years ago
Ramya Nagarajan	e014b4d970	api: update acl/validate data format (#4366 ) Expected input is JSON formatted []policy.ACLTest Signed-off-by: Ramya Nagarajan <ramya@tailscale.com>	3 years ago
Brad Fitzpatrick	dd6472d4e8	api: document preauthorized auth keys Fixes #2120 Change-Id: If6a803680b544df1f70449c26fd0f5e15940226b Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	3 years ago
Sonia Appasamy	aaba49ca10	api.md: add docs for device tags and keys endpoints Signed-off-by: Sonia Appasamy <sonia@tailscale.com>	3 years ago
Joe Tsai	66164b9307	api: document API endpoint to manipulate keys (#3544 ) The new /keys endpoint allows you to list API and machine auth keys. You can also create machine auth key. It currently does not support creating another API key. Signed-off-by: Joe Tsai <joetsai@digital-static.net>	3 years ago
Brad Fitzpatrick	a76c8eea58	api: document new API to authorize a device (#2825 ) Fixes #2813 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>	3 years ago
Will Lachance	5d3427021b	Minor corrections to the API documentation * The right web address for configuring API keys seems to have changed * Minor clarification on how basic authentication works (it's illustrated in the examples later, but can't hurt to be precise) Signed-off-by: William Lachance <wlach@protonmail.com>	3 years ago
slowy07	ac0353e982	fix: typo spelling grammar Signed-off-by: slowy07 <slowy.arfy@gmail.com>	3 years ago
Aaditya Chaudhary	71b375c502	api.md: add acl validation docs Signed-off-by: Aaditya Chaudhary <32117362+AadityaChaudhary@users.noreply.github.com>	3 years ago
Denton Gentry	64ee6cf64b	api.md: update preview example The implementation of the preview function has changed since the API was documented, update the document to match. Signed-off-by: Denton Gentry <dgentry@tailscale.com>	3 years ago
Daniel Chung	5e90037f1a	api.md: clarify response behaviour for ACL POST endpoint Signed-off-by: Daniel Chung <daniel@tailscale.com>	4 years ago
Brad Fitzpatrick	b405644f5d	api.md: add TOC	4 years ago
Christina Wen	a746ff5de7	API.md: add documentation for deleting a device Signed-off-by: Christina Wen <christina@tailscale.com>	4 years ago
Christina Wen	8d7ddf5e94	API.md: rename "domain" to "tailnet" Signed-off-by: Christina Wen <christina@tailscale.com>	4 years ago
Christina Wen	d8a5b3f22f	API.md: revise documentation to be more consistent Signed-off-by: Christina Wen <christina@tailscale.com>	4 years ago

1 2

51 Commits (64d70fb718557f73a3cebdc41558405697b913ec)