IP network template management. IP network templates can be assigned to a device to define a network adapter settings. There are Ethernet and Wifi templates.
Get IP network templates for an organization. You can search by template name, interface type, as well as sort the list.
path Parameters
orgIdstring · requiredThe id of the organization.
query Parameters
nameFilterstringOptional filter for network template name (case-insensitive partial match).
typeFilterstring · enumOptional filter for network template communication interface type (Wifi/Ethernet).
Enum values:NoneEthernetWifisortBystring · enumSorting field for results. Default is Name.
Enum values:NameLastEditedsortDirectionstring · enumSorting direction for results.
Enum values:AscendingDescendinglimitinteger · int32The number of records to return. Max 30.
pageinteger · int32The page offset when fetching the records
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataarray | nullsuccessbooleanerrorsarray | null
Creates a new IP network template for a given comm interface in the current organization.
path Parameters
orgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
ipNetworkTemplateNamestring · minLength: 1 · requiredThe name of the network template. The fields can be overridden after applying them to a device.
commInterfacestring · enum · requiredEnum values:NoneEthernetWifinetmaskstring · minLength: 1 · requiredThe netmask of the template.
gatewayIpAddressstring | nullThe gateway of the template.
nameserversarray | nullA list of nameservers for the template.
ssidstring | nullThe Ssid for the network. Only applies to Wifi network templates.
passwordstring | nullThe password for the network. Only applies to Wifi network templates.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null
Get an IP network template by ID
path Parameters
idstring · uuid · requiredorgIdstring · requiredThe id of the organization.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
dataobjectsuccessbooleanerrorsarray | null