Server Information Structure

A Server Information structure is returned from getServerInfo().

allowRemoteControl
This indicates whether the server accepts API connections from remote hosts. If this is false, API connections are only accepted from localhost.
apiControlPort
The port number on which the server will accept API connections.
APITokensAvailable
This indicates whether the server supports creation and use of API tokens. See createAPIToken().
apiVersion
The API compatibility version for the connected server. API methods are aware of the server version required, and will report an error if the API versions do not match.
authRequired
This indicates whether this server requires authentication for API connections. If True then you must call either auth() or authAsync() after calling connect().
bandwidthLimits
Server Bandwidth Limits Structure
certificateValidation
Number of days remaining until SSL certificate expiry.
configuration
Server Configuration Structure. Note that this key only exists for superusers. See superuser().
encryptionAvailable
This indicates whether this server supports encrypted connections.
eventLogAvailable
This indicates whether the server’s event log is active. If active, the getEventLog command may be used to retrieve the server’s event history.
hostName
The name of the machine host that is running the server. This is different from the serverName, which is assigned to the JetStream server itself.
license
Server License Structure
multiplexAvailable
This indicates whether the same port number can be used for both the sending and receiving traffic. If multiplex is not supported, unique ports must be used for each.
publicKey
A server’s public key, used for encrypted connections.
receiver
Receiver Server Information Structure
revision
An integer representing revision (version) of the server.
serverExternalAddress
Hostname and port, as specified by the --external-address option at server start.
serverId
A string that uniquely identifies a server instance. This ID is regenerated every time a server is launched.
serverName
A friendly name assigned to a server.
serverPlatform
A string that represents the OS running the server. One of windows, linux, or macOS.
serverTime
A timestamp indicating the current time on this server. See Timestamps.
serverUid
A string that uniquely identifies a server. This ID is generated once, and stored in the server’s persistent state.
sharedTokensAvailable
This indicates whether the server supports creation and use of shared tokens. See createSharedToken().
user
Server User Structure
version
A string representing the version of the server.

Changed in version 1.5.0: Added version and revision keys.

Changed in version 1.6.0: Added bandwidthLimits.

Changed in version 1.7.0: Added certificateValidation.

Changed in version 2.4.0: Added APITokensAvailable.

Receiver Server Information Structure

A Receiver Server Information structure is returned as part of the Server Information Structure.

authRequired
True if the server required a username and password for transfers.
encryptionEnabled
True if the server has encryption enabled. If encryption is enabled, transfers can only be initiated to a server which also has encryption enabled.
onlyAuthorizedClientsAllowed
Indicates whether this receiving server allows only pre-authenticated clients. Clients may be pre-authenticated using the addAuthorizedClientAsync() command.
receiverIP
The IP for the receiver connection. An IP of 0.0.0.0 is a wildcard that means the server is listening for connections from any IP.
receiverPort
The port for the receiver connection.
relayIP
The IP for the relay server, if using a relay. Will be None if not using a relay.
relayPort
The port for the relay server, if using a relay. Will be None if not using a relay.
socketRecvBufferSize
The size of the buffer allocated for receiving data.
socketSendBufferSize
The size of the buffer allocated for sending data.

Server Bandwidth Limits Structure

A Bandwidth Limits structure is returned as part of the Server Information Structure.

borrowIncoming
If both incoming and outgoing rate limits are active, add unused incoming bandwidth to the outgoing rate limit.
borrowOutgoing
If both incoming and outgoing rate limits are active, add unused outgoing bandwidth to the incoming rate limit.
incomingLimitActive
Whether incoming limits are applied.
incomingMaxConnections
The maximum number of incoming connections.
incomingRateLimit
The maximum incoming data rate, in kilobits-per-second.
outgoingLimitActive
Whether outgoing limits are applied.
outgoingRateLimit
The maximum outgoing data rate, in kilobits-per-second.

Server Configuration Structure

A Configuration structure is returned as part of the Server Information Structure. It holds data about how the server is configured and is only available to a superuser. See superuser().

fileCache
File Cache Structure
garbageCollect
Garbage Collection Structure
persistentStateDir
The path to which the server will save its encryption key files. If this directory is specified at launch, the server will provide a consistent public key for its encryption interfaces.
triggersAvailable
This indicates whether the server’s trigger system is active. If active, any triggers found in the triggersDir will be executed in response to their associated events.

Changed in version 1.8.0: Added fileCache and garbageCollect keys.

File Cache Structure

A File Cache structure is returned as part of the Server Configuration Structure. It holds the server’s file cache information.

highWatermark
The size, in bytes, of memory allocated to file cache.
maximumSize
Maximum size, in bytes, of the file cache. This can be defined at server startup using --max-file-cache-size

Garbage Collection Structure

A Garbage Collection structure is returned as part of the Server Configuration Structure. It holds the server’s garbage collection configuration.

intervalSeconds
The time, in seconds, between each garbage collection.
timeLimitSeconds
The grace period, in seconds, to allow for items that are ready to be garbage collected.

Server License Structure

A License structure is returned as part of the Server Information Structure.

errorMessage
If a license is invalid, a message indicating the reason.
expiry
The date on which the JetStream license expires for this server.
valid
This indicates whether the license is currently valid (True) or invalid (False).

Server User Structure

A User structure is returned as part of the Server Information Structure.

authed
This indicates whether authentication has been performed on the current API connection.
permissions
Permissions granted to this user. See PERMISSIONS
sandboxed
This indicates whether the user is restricted to a sandbox directory, instead of full filesystem access. Returns None when not authenticated.
superuser
This indicates whether the authenticated user is a superuser. If not authenticated, this will be False.
token
The token of the currently authenticated user. If not authenticated or user name auth was used, this will be None.
tokenSession
The token session of the currently authenticated user. If not authenticated or user name auth was used, this will be None.
userName
The name of the currently authenticated user. If not authenticated or if token auth was used, this will be None.

Changed in version 1.5.0: Renamed username to userName.

Changed in version 2.4.0: Added permissions.