From 64ee6cf64b31398d850ec8406ec989c83d06bc65 Mon Sep 17 00:00:00 2001 From: Denton Gentry Date: Thu, 1 Jul 2021 20:46:42 -0700 Subject: [PATCH] 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 --- api.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/api.md b/api.md index ccd539027..8ee452f92 100644 --- a/api.md +++ b/api.md @@ -471,15 +471,16 @@ Determines what rules match for a user on an ACL without saving the ACL to the s ##### Parameters ###### Query Parameters -`user` - A user's email. The provided ACL is queried with this user to determine which rules match. +`type` - can be 'user' or 'ipport' +`previewFor` - if type=user, a user's email. If type=ipport, a IP address + port like "10.0.0.1:80". +The provided ACL is queried with this paramater to determine which rules match. ###### POST Body ACL JSON or HuJSON (see https://tailscale.com/kb/1018/acls) ##### Example ``` -POST /api/v2/tailnet/example.com/acl/preiew -curl 'https://api.tailscale.com/api/v2/tailnet/example.com/acl?user=user1@example.com' \ +curl 'https://api.tailscale.com/api/v2/tailnet/example.com/acl/preview?previewFor=user1@example.com&type=user' \ -u "tskey-yourapikey123:" \ --data-binary '// Example/default ACLs for unrestricted connections. {