From c8f76b5e2cf6bfdc52af1924114e8dff40394821 Mon Sep 17 00:00:00 2001 From: Ryan Uber Date: Mon, 15 Jun 2015 11:45:08 -0700 Subject: [PATCH] website: document passing ACL tokens in catalog register/deregister --- .../docs/agent/http/catalog.html.markdown | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/website/source/docs/agent/http/catalog.html.markdown b/website/source/docs/agent/http/catalog.html.markdown index 41a6e75e62..734c702b94 100644 --- a/website/source/docs/agent/http/catalog.html.markdown +++ b/website/source/docs/agent/http/catalog.html.markdown @@ -88,6 +88,17 @@ to indicate that the initial check has not been performed yet. It is important to note that `Check` does not have to be provided with `Service` and vice versa. A catalog entry can have either, neither, or both. +An optional ACL token may be provided to perform the registration by including a +`WriteRequest` block in the query payload, like this: + +```javascript +{ + "WriteRequest": { + "Token": "foo" + } +} +``` + If the API call succeeds, a 200 status code is returned. ### /v1/catalog/deregister @@ -130,6 +141,17 @@ all associated services and checks are deleted. If `CheckID` is provided, only that check is removed. If `ServiceID` is provided, the service and its associated health check (if any) are removed. +An optional ACL token may be provided to perform the deregister action by adding +a `WriteRequest` block to the payload, like this: + +```javascript +{ + "WriteRequest": { + "Token": "foo" + } +} +``` + If the API call succeeds a 200 status code is returned. ### /v1/catalog/datacenters