summaryrefslogtreecommitdiffhomepage
path: root/api.md
AgeCommit message (Collapse)AuthorFilesLines
2024-09-13{api.md,publicapi}: remove old API docs (#13468)Mario Minardi1-102/+0
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>
2024-07-10publicapi: add note that API docs have moved to existing docs files (#12770)Mario Minardi1-0/+3
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>
2024-05-20api.md: direct TOC links to new publicapi docs locationCharlotte Brandhorst-Satzkorn1-2678/+63
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>
2024-05-15api.md: document device invite apisSonia Appasamy1-1/+333
Updates tailscale/corp#18153 Signed-off-by: Sonia Appasamy <sonia@tailscale.com>
2024-05-15api.md: document user invite apisSonia Appasamy1-0/+246
Updates tailscale/corp#18153 Signed-off-by: Sonia Appasamy <sonia@tailscale.com>
2024-05-08api.md: remove extraneous commas in json examplesSonia Appasamy1-52/+51
Updates #cleanup Signed-off-by: Sonia Appasamy <sonia@tailscale.com>
2024-04-30api.md: add documentation for new split DNS endpoints (#11922)Mario Minardi1-0/+162
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>
2024-04-29api.md: explicitly set content-type headers in POST CURL examples (#11916)Mario Minardi1-5/+21
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>
2024-04-29api.md: fix missing links after move of device postureKristoffer Dalby1-2/+2
Updates tailscale/corp#18572 Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2024-04-23api.md: move device posture api to api.mdKristoffer Dalby1-0/+133
Updates tailscale/corp#18572 Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2024-03-19api.md: add missing backtick to GET searchpaths doc (#11459)Mario Minardi1-1/+1
Add missing backtick to GET searchpaths api documentation. Updates #cleanup Signed-off-by: Mario Minardi <mario@tailscale.com>
2024-03-19api.md: format API docs with prettierWill Norris1-200/+188
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>
2024-03-18api.md: document device expiration endpointWill Norris1-0/+34
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>
2023-12-20api.md: add docs for setting an IP addressDavid Crawshaw1-1/+48
Updates tailscale/corp#16453 Signed-off-by: David Crawshaw <crawshaw@tailscale.com>
2023-12-19api.md: add device.postureIdentity fieldPaul Scott1-0/+10
Updates tailscale/corp#15445 Signed-off-by: Paul Scott <paul@tailscale.com>
2023-10-06api.md: remove clientConnectivity.derp fieldBrad Fitzpatrick1-4/+0
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>
2023-09-24api.md: document the `invalid` field in Get Key API responseAnton Tolchanov1-0/+12
Updates tailscale/terraform-provider-tailscale#144 Signed-off-by: Anton Tolchanov <anton@tailscale.com>
2023-07-27api.md: update device authorize API docs to allow for deauth (#8728)tinku-tailscale1-1/+2
Signed-off-by: tinku-tailscale <139132124+tinku-tailscale@users.noreply.github.com>
2023-07-21api.md: add documentation to API endpoint about SCIM group warningsJenny Zhang1-0/+15
Updates #8645 Signed-off-by: Jenny Zhang <jz@tailscale.com>
2023-06-27all: adjust case of "IPv4" and "IPv6"Brad Fitzpatrick1-2/+2
Updates #docs Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2023-06-23api.md: add info for key description (#8429)phirework1-3/+14
Updates tailscale/corp#7773 Signed-off-by: Jenny Zhang <jz@tailscale.com>
2023-05-22api.md: update device authorized API docs to allow for deauth (#8162)salman aljammaz1-2/+3
The authorize device API (/api/v2/device/{deviceID}/authorized) will soon allow device deauthorisation. Fixes corp#10160. Signed-off-by: salman <salman@tailscale.com>
2023-04-14api.md: update example auth key valueWill Norris1-3/+3
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>
2023-03-02api.md: refresh of API docsJulia at Tailscale1-599/+1156
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>
2022-12-05api.md: change "admin panel" to "admin console"Julia Stein1-1/+1
Signed-off-by: Julia Stein <julia@tailscale.com>
2022-12-02api.md: lowercase ACL field namesAnton Tolchanov1-34/+34
Making this match https://tailscale.com/kb/1018/acls Signed-off-by: Anton Tolchanov <anton@tailscale.com>
2022-12-02api.md: update documentation for the "set ACL" endpointAnton Tolchanov1-0/+5
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>
2022-11-07api.md: make it clearer where to get the tailnet name in API callsMihai Parparita1-5/+4
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>
2022-10-19api.md: add expirySeconds as parameter to post Tailnet keysMaisem Ali1-1/+6
Updates #4570 Signed-off-by: Maisem Ali <maisem@tailscale.com>
2022-10-13api.md: document using '-' value as default tailnetWill Norris1-0/+7
Signed-off-by: Will Norris <will@tailscale.com>
2022-07-21api.md: added missing quote to POST DNS Searchpaths request body exampleLogan Saso1-1/+1
Signed-off-by: Logan Saso <logansaso@gmail.com>
2022-05-17api.md: document preauthorized and tags fieldsDenton Gentry1-5/+11
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>
2022-05-05api.md: update GET tailnet key detail docs to show preauthorized, tagsBrad Fitzpatrick1-4/+16
Fixes #4571 Change-Id: If81471d0d8cb2f659736991ad8612aed2efc174e Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2022-04-29Revert "api: document preauthorized auth keys"Brad Fitzpatrick1-6/+1
This reverts commit dd6472d4e87f823cb14a611a582afc25827cc46b. 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>
2022-04-28api.md: remove descriptions from TOC (#4561)Walter Poupore1-35/+35
2022-04-27api.md: document new ACL validate modeBrad Fitzpatrick1-6/+30
Updates tailscale/corp#4932 Change-Id: Ie176ee79595c3b56d3376f1d81a441f9272e6ed4 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2022-04-07api: update acl/validate data format (#4366)Ramya Nagarajan1-3/+1
Expected input is JSON formatted []policy.ACLTest Signed-off-by: Ramya Nagarajan <ramya@tailscale.com>
2022-02-17api: document preauthorized auth keysBrad Fitzpatrick1-1/+6
Fixes #2120 Change-Id: If6a803680b544df1f70449c26fd0f5e15940226b Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2022-02-04api.md: add docs for device tags and keys endpointsSonia Appasamy1-0/+66
Signed-off-by: Sonia Appasamy <sonia@tailscale.com>
2021-12-16api: document API endpoint to manipulate keys (#3544)Joe Tsai1-0/+158
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>
2021-09-09api: document new API to authorize a device (#2825)Brad Fitzpatrick1-4/+33
Fixes #2813 Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
2021-08-28Minor corrections to the API documentationWill Lachance1-1/+1
* 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>
2021-08-24fix: typo spelling grammarslowy071-1/+1
Signed-off-by: slowy07 <slowy.arfy@gmail.com>
2021-08-22api.md: add acl validation docsAaditya Chaudhary1-0/+45
Signed-off-by: Aaditya Chaudhary <32117362+AadityaChaudhary@users.noreply.github.com>
2021-07-02api.md: update preview exampleDenton Gentry1-3/+4
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>
2021-04-10api.md: clarify response behaviour for ACL POST endpointDaniel Chung1-6/+33
Signed-off-by: Daniel Chung <daniel@tailscale.com>
2021-01-19api.md: add TOCBrad Fitzpatrick1-6/+56
2021-01-12API.md: add documentation for deleting a deviceChristina Wen1-9/+45
Signed-off-by: Christina Wen <christina@tailscale.com>
2021-01-12API.md: rename "domain" to "tailnet"Christina Wen1-56/+83
Signed-off-by: Christina Wen <christina@tailscale.com>
2021-01-05API.md: revise documentation to be more consistentChristina Wen1-41/+80
Signed-off-by: Christina Wen <christina@tailscale.com>
Copyright © 2025 - 2026 Wayne Cole. WTFPL. Attribution appreciated. No warranty. Not liable for bodily damages.