summaryrefslogtreecommitdiff
path: root/controller
diff options
context:
space:
mode:
authorAdam Ierymenko <adam.ierymenko@zerotier.com>2017-07-07 09:32:37 -0700
committerGitHub <noreply@github.com>2017-07-07 09:32:37 -0700
commit782b2b1514e195cd006374a71aceedae609f0421 (patch)
tree0f78570593b142a2b78c44e1d35f20a003f5fd1c /controller
parenta9582417e290746826503fad84b78c2296431405 (diff)
parent9b2e08dd09b88e94b459a84764d47590531a5ef9 (diff)
downloadinfinitytier-782b2b1514e195cd006374a71aceedae609f0421.tar.gz
infinitytier-782b2b1514e195cd006374a71aceedae609f0421.zip
Merge pull request #537 from laduke/patch-1
Update README.md
Diffstat (limited to 'controller')
-rw-r--r--controller/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/controller/README.md b/controller/README.md
index d70ffd2a..8a1a3dff 100644
--- a/controller/README.md
+++ b/controller/README.md
@@ -69,6 +69,12 @@ By making queries to this path you can create, configure, and delete networks. D
When POSTing new networks take care that their IDs are not in use, otherwise you may overwrite an existing one. To create a new network with a random unused ID, POST to `/controller/network/##########______`. The #'s are the controller's 10-digit ZeroTier address and they're followed by six underscores. Check the `nwid` field of the returned JSON object for your network's newly allocated ID. Subsequent POSTs to this network must refer to its actual path.
+Example:
+
+`curl -X POST --header "X-ZT1-Auth: secret" -d '{"name":"my network"}' http://localhost:9993/controller/network/305f406058______`
+
+**Network object format:**
+
| Field | Type | Description | Writable |
| --------------------- | ------------- | ------------------------------------------------- | -------- |
| id | string | 16-digit network ID | no |