network

Create a new network.

post/network

Request

  • Base URL
    https://api.zerotier.com/api/v1
  • Auth
    HTTP token

Request body

object required

Response

Network creation succeeded

idstring nullable
clockinteger nullable
descriptionstring nullable
rulesSourcestring nullable

The flow rules source code in ZeroTier rule language. Set this field to update network rules.

permissionsPermissionsMap
ownerIdstring nullable
onlineMemberCountinteger nullable

Note: May be 0 on endpoints returning lists of Networks

authorizedMemberCountinteger nullable
totalMemberCountinteger nullable
capabilitiesByNameobject nullable
tagsByNameobject nullable

Example response

{
  "id": "8056c2e21c000001",
  "clock": 12345,
  "config": {
    "id": "8056c2e21c000001",
    "creationTime": 1442292672978,
    "dns": {
      "domain": "some.domain",
      "servers": [
        "10.0.0.3"
      ]
    },
    "enableBroadcast": true,
    "ipAssignmentPools": [
      {
        "ipRangeStart": "10.0.0.1",
        "ipRangeEnd": "10.0.0.255"
      }
    ],
    "lastModified": 1588184318235,
    "mtu": 2800,
    "multicastLimit": 32,
    "name": "My ZeroTier Network",
    "private": true,
    "routes": [
      {
        "target": "10.0.0.0/24"
      }
    ],
    "ssoConfig": {
      "enabled": true,
      "mode": "default",
      "clientId": "some-client-id",
      "issuer": "https://example.com/oidc",
      "provider": "keycloak"
    },
    "v4AssignMode": {
      "zt": true
    },
    "v6AssignMode": {
      "6plane": true
    }
  },
  "description": "Some descriptive text about my network.",
  "rulesSource": "accept;",
  "permissions": {
    "00000000-0000-0000-0000-000000000000": {
      "a": true,
      "d": true,
      "m": true,
      "r": true
    }
  },
  "ownerId": "00000000-0000-0000-0000-000000000000",
  "onlineMemberCount": 123,
  "authorizedMemberCount": 200,
  "totalMemberCount": 250
}

Changes

No recorded changes to this operation across all 1 revision of this API.