diff options
| author | Travis LaDuke <travisladuke@gmail.com> | 2017-06-26 11:27:07 -0700 |
|---|---|---|
| committer | Travis LaDuke <travisladuke@gmail.com> | 2017-06-26 11:53:35 -0700 |
| commit | 9b2e08dd09b88e94b459a84764d47590531a5ef9 (patch) | |
| tree | b330e6daa48627a8590bc9d42e8e22cbddf8c894 | |
| parent | fe5257df81c4ec4b5d48f707eb794de0748b7ac0 (diff) | |
| download | infinitytier-9b2e08dd09b88e94b459a84764d47590531a5ef9.tar.gz infinitytier-9b2e08dd09b88e94b459a84764d47590531a5ef9.zip | |
Update README.md
We've had multiple questions in the community chat regarding posting new
network and getting the curl syntax correct.
| -rw-r--r-- | controller/README.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/controller/README.md b/controller/README.md index db8d0153..b21b3058 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 | |