Server Information Structure¶
A Server Information structure is returned from
This indicates whether the server accepts API connections from remote hosts. If this is false, API connections are only accepted from localhost.
The port number on which the server will accept API connections.
This indicates whether the server supports creation and use of API tokens. See
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.
Number of days remaining until SSL certificate expiry.
This indicates whether this server supports encrypted connections.
This indicates whether the server’s event log is active. If active, the
getEventLogcommand may be used to retrieve the server’s event history.
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.
A server’s minimum supported transfer cipher.
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.
A server’s public key, used for encrypted connections.
An integer representing revision (version) of the server.
Hostname and port, as specified by the
--external-addressoption at server start.
A string that uniquely identifies a server instance. This ID is regenerated every time a server is launched.
A friendly name assigned to a server.
A string that represents the OS running the server. One of
A timestamp indicating the current time on this server. See Timestamps.
A string that uniquely identifies a server. This ID is generated once, and stored in the server’s persistent state.
This indicates whether the server supports creation and use of shared tokens. See
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.
Trueif the server required a username and password for transfers.
Trueif the server has encryption enabled. If encryption is enabled, transfers can only be initiated to a server which also has encryption enabled.
Indicates whether this receiving server allows only pre-authenticated clients. Clients may be pre-authenticated using the
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.
The port for the receiver connection.
The IP for the relay server, if using a relay. Will be
Noneif not using a relay.
The port for the relay server, if using a relay. Will be
Noneif not using a relay.
The size of the buffer allocated for receiving data.
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.
If both incoming and outgoing rate limits are active, add unused incoming bandwidth to the outgoing rate limit.
If both incoming and outgoing rate limits are active, add unused outgoing bandwidth to the incoming rate limit.
Whether incoming limits are applied.
The maximum number of incoming connections.
The maximum incoming data rate, in kilobits-per-second.
Whether outgoing limits are applied.
The maximum outgoing data rate, in kilobits-per-second.
Server Configuration Structure¶
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.
This indicates whether the server’s trigger system is active. If active, any triggers found in the
triggersDirwill be executed in response to their associated events.
Changed in version 1.8.0: Added fileCache and garbageCollect keys.
Changed in version 2.6.0: Renamed fileCache to cloudFileCache.
Cloud File Cache Structure¶
A Cloud File Cache structure is returned as part of the Server Configuration Structure. It holds the server’s cloud file cache information.
Garbage Collection Structure¶
A Garbage Collection structure is returned as part of the Server Configuration Structure. It holds the server’s garbage collection configuration.
The time, in seconds, between each garbage collection.
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.
Server User Structure¶
A User structure is returned as part of the Server Information Structure.
This indicates whether authentication has been performed on the current API connection.
Permissions granted to this user. See
This indicates whether the user is restricted to a sandbox directory, instead of full filesystem access. Returns
Nonewhen not authenticated.
This indicates whether the authenticated user is a superuser. If not authenticated, this will be
The token of the currently authenticated user. If not authenticated or user name auth was used, this will be
The token session of the currently authenticated user. If not authenticated or user name auth was used, this will be
The name of the currently authenticated user. If not authenticated or if token auth was used, this will be
Changed in version 1.5.0: Renamed username to userName.
Changed in version 2.4.0: Added permissions.