ZeroTierOne API Spec

OpenAPI and JSON-schema for the ZeroTierOne service API.

This is the API that lets you leave and join networks on your local machine, or configure a self-hosted network controller.

The specs are generated from a typespec spec.

dev

npm install 
npm start

Open http://localhost:8080

test

This integration test requires zerotier-one to be running. It may change configuration of your node! It runs in github actions too.

AUTH_TOKEN=$(cat /path/to/authtoken.secret) npm test

missing features

Features not implemented by typespec yet

• openapi examples
• tag descriptions

publishing

How to create a github release.

Releases contain the openapi and json-schema files.

Try to use conventional commit messages if you want. They will appear in the changelog.

• Go into the repo's Github Actions
• Click "npm version && npm publish"
• Click Run Workflow
• Type "patch", "minor", or "major" and submit

On the CLI you can do:

npm version {major,minor,patch}
npm run release

The url to the latest release of the openapi spec is: https://github.com/zerotier/zerotier-one-api-spec/releases/latest/download/openapi.yaml