zerotier-central-api 1.0.3

OpenAPI bindings to the ZeroTier Central (https://my.zerotier.com) service
Documentation

Rust API client for zerotier-central-api

ZeroTier Central Network Management Portal API.All API requests must have an API token header specified in the Authorization: Bearer xxxxx format. You can generate your API key by logging into <a href="https://my.zerotier.com\">ZeroTier Central and creating a token on the Account page.eg. curl -X GET -H "Authorization: bearer xxxxx" https://my.zerotier.com/api/v1/networkRate LimitingThe ZeroTier Central API implements rate limiting. Paid users are limited to 100 requests per second. Free users are limited to 20 requests per second. You can get the OpenAPI spec here as well: https://docs.zerotier.com/openapi/centralv1.json

For more information, please visit https://discuss.zerotier.com

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: v1
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named zerotier-central-api and add the following to Cargo.toml under [dependencies]:

zerotier-central-api = { path = "./zerotier-central-api" }

Documentation for API Endpoints

All URIs are relative to https://my.zerotier.com/api/v1

Class Method HTTP request Description
NetworkApi delete_network DELETE /network/{networkID} delete network
NetworkApi get_network_by_id GET /network/{networkID} Get network by ID
NetworkApi get_network_list GET /network Returns a list of Networks you have access to.
NetworkApi new_network POST /network Create a new network.
NetworkApi update_network POST /network/{networkID} update network configuration
NetworkMemberApi delete_network_member DELETE /network/{networkID}/member/{memberID} Delete a network member
NetworkMemberApi get_network_member GET /network/{networkID}/member/{memberID} Return an individual member on a network
NetworkMemberApi get_network_member_list GET /network/{networkID}/member Returns a list of Members on the network.
NetworkMemberApi update_network_member POST /network/{networkID}/member/{memberID} Modify a network member
OrganizationsApi accept_invitation POST /org-invitation/{inviteID} Accept organization invitation
OrganizationsApi decline_invitation DELETE /org-invitation/{inviteID} Decline organization invitation
OrganizationsApi get_invitation_by_id GET /org-invitation/{inviteID} Get organization invitation
OrganizationsApi get_organization GET /org Get the current user's organization
OrganizationsApi get_organization_by_id GET /org/{orgID} Get organization by ID
OrganizationsApi get_organization_invitation_list GET /org-invitation Get list of organization invitations
OrganizationsApi get_organization_members GET /org/{orgID}/user Get list of organization members
OrganizationsApi invite_user_by_email POST /org-invitation Invite a user to your organization by email
UserApi add_api_token POST /user/{userID}/token Add an API token
UserApi delete_api_token DELETE /user/{userID}/token/{tokenName} Delete API Token
UserApi delete_user_by_id DELETE /user/{userID} Delete user
UserApi get_user_by_id GET /user/{userID} Get user record
UserApi update_user_by_id POST /user/{userID} Update user record (SMS number or Display Name only)
UtilApi get_random_token GET /randomToken Get a random 32 character token
UtilApi get_status GET /status Obtain the overall status of the account tied to the API token in use.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author