website: document passing ACL tokens in catalog register/deregister

pull/1037/head
Ryan Uber 2015-06-15 11:45:08 -07:00
parent e3b3c99801
commit c8f76b5e2c
1 changed files with 22 additions and 0 deletions

View File

@ -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.
### <a name="catalog_deregister"></a> /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.
### <a name="catalog_datacenters"></a> /v1/catalog/datacenters