Skip to content

zerotier/zerotier-one-api-spec

Repository files navigation

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

The integration test requires docker to be running.

npm test

missing features

Features not implemented by typespec yet

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 to the Actions Tab
  • Click Release on the left
  • Click Run Workflow on the right
  • Type in the appropriate version (patch)
  • Click run

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