Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP Central API sample code for CSV exports #136

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

WIP Central API sample code for CSV exports #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/api-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: ZeroTier API Examples
description: "Code snippets and usage examples for the ZeroTier Central API"
---

In the examples below use the following placeholder variables to match commonly-needed parameters:

- `$CENTRAL_TOKEN`: an API token associated with an active account on [Central](https://my.zerotier.com)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the examples, $ZT_TOKEN is used

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had originally thought this document might be a single resource for both APIs, but now that it's specific to Central using the standard $ZT_TOKEN placeholder makes sense. It is potentially confusing if folks are looking at both sets of API docs, since the format, source, and request-time usage of the token are all different. :|

- `$NWID`: an active network ID

# Exporting Data from the Central API

The examples below are intended to run in a system terminal, and require the following command-line tools:

- [curl](https://curl.so)
- [jq](https://jqlang.github.io/jq/)

Each of them will fetch network information and produce CSV as output. You can then import that CSV into your choice of database, spreadsheet, or configuration-management tool(s).

## List current networks associated with an account

```sh
curl -s -H "Authorization: token $ZT_TOKEN" \
"https://api.zerotier.com/api/v1/network" \
| jq '.[] | [
.id,
.config.name,
.config.description,
.totalMemberCount,
.config.creationTime,
.config.ipAssignmentPools[0].ipRangeStart,
.config.ipAssignmentPools[0].ipRangeEnd
]' \
| jq -rs '.[] | @csv'
```

## List network members

```sh
curl -H "Authorization: token $ZT_TOKEN" \
"https://api.zerotier.com/api/v1/network/$NWID/member" \
| jq '.[] | [
.id,
.lastSeen,
.physicalAddress,
.ipAssignments[0],
.name
]' \
| jq -rs '.[] | @csv
```