(408) 943-4100               V   Commercial Support

servers/available

  1 minute read.

Last Modified 2021-02-04 11:38 EST
NamespaceNameAdmin OnlyLog SummaryGenerates EventVersion AddedVersion Removed
serversavailableyesnono1.3

Description

[Cloud-instance only] Display the list of NAS’s that are currently available within the wireguard network. This only displays the nicknames and internal wireguard IP’s of the systems as generated by the cloud-instance account portal. It does not verify the availability of the systems in any way.

NOTE: Administrator access only - all others will get a 403/Forbidden error

Input Arguments

  • Required:
    • none ({})
  • Optional:
    • none ({})

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{}

Reply Example

{
  "available" : {
    "172.28.0.13" : "my-nas.local",
    "172.28.0.19" : "nas2.local"
  }
}

Events

This API call does not emit any middleware events.

Log Summary

This API call does not generate a detailed log summary item

See Also