getSystemInfo

Gets information about the server

Requires authentication as user

Request
get /System/Info
Responses
Status Code Type Description Samples
200 SystemInfo

Operation successful. Returning a SystemInfo object.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

SystemInfo

Name Type Notes
SystemUpdateLevel PackageVersionClass

Enum PackageVersionClass
OperatingSystemDisplayName string

The display name of the operating system.
PackageName string
HasPendingRestart boolean

A value indicating whether this instance has pending restart.
IsShuttingDown boolean
HasImageEnhancers boolean
OperatingSystem string

The operating sytem.
SupportsLibraryMonitor boolean

A value indicating whether [supports library monitor].
SupportsLocalPortConfiguration boolean
SupportsWakeServer boolean
WebSocketPortNumber integer (int32)

The web socket port number.
CompletedInstallations InstallationInfo[]

The completed installations.
CanSelfRestart boolean

A value indicating whether this instance can self restart.
CanSelfUpdate boolean

A value indicating whether this instance can self update.
CanLaunchWebBrowser boolean
ProgramDataPath string

The program data path.
ItemsByNamePath string

The items by name path.
CachePath string

The cache path.
LogPath string

The log path.
InternalMetadataPath string

The internal metadata path.
TranscodingTempPath string

The transcoding temporary path.
HttpServerPortNumber integer (int32)

The HTTP server port number.
SupportsHttps boolean

A value indicating whether [enable HTTPS].
HttpsPortNumber integer (int32)

The HTTPS server port number.
HasUpdateAvailable boolean

A value indicating whether this instance has update available.
SupportsAutoRunAtStartup boolean

A value indicating whether [supports automatic run at startup].
HardwareAccelerationRequiresPremiere boolean
WakeOnLanInfo WakeOnLanInfo[]
IsInMaintenanceMode boolean
LocalAddress string

The local address.
LocalAddresses array
WanAddress string

The wan address.
RemoteAddresses array
ServerName string

The name of the server.
Version string

The version.
Id string

The id.

PackageVersionClass

Enum Values
  • Release
  • Beta
  • Dev

InstallationInfo

Name Type Notes
Id string (guid)

The id.
Name string

The name.
AssemblyGuid string

The assembly guid.
Version string

The version.
UpdateClass PackageVersionClass

Enum PackageVersionClass
PercentComplete number (double)

The percent complete.

WakeOnLanInfo

Name Type Notes
MacAddress string
BroadcastAddress string
Port integer (int32)