ServerStateData

Provides information about an actual server state.

Properties

Parameter Type Description
Name string Name of the server.
StateCode int

Current server state:

  • 1 = running
  • 2 = updating
  • 3 = suspending
State string String representation of the current server state.
ServiceVersion string

Deprecated.

Current version of the server in format: “<major>.<minor>.<build>”. For example: “1.60.2995”.

ProtocolVersion string

Service communication protocol version in format: “<major>.<minor>.<build>”. For example: “1.0.1”

The build number can change without the interface changing (adding optional parameters, adding new methods). Change in the major or the minor version means the interface change and the client who doesn’t support new version of interface shouldn’t continue working and needs to be upgraded.

JSON Example

{
    "Name": "Meddbase server",
    "StateCode": 1,
    "State": "Running",
    "ServiceVersion": "<deprecated>",
    "ProtocolVersion": "1.0.1"
}