Returns information about this server.

This method can be called without an access token.

Parameters

This method does not take any parameters.

Result

An object:

domain
string

The domain of this server.

name
string

The display name of this server.

description
string

The long description of this server (HTML).

short_description
string

The short description of this server (HTML).

version
string

The version of Smithereen running on this server.

policy
string

The server policy, as displayed on /system/about (HTML).

rules
array of objects

The server rules. If there are translations, the returned strings will be different depending on the language (the lang parameter or the current user’s setting).

id
integer

Rule identifier.

title
string

The short title of this rule.

description
string

The description of this rule.

admin_email
string

The server administrator’s email.

admins
array of users

The array of user objects representing the server administrators.

signup_mode
enum

The sign-up mode currently in effect on this server.

  • open – Anyone can freely register on their own.
  • closed – This server does not accept new users.
  • invite_only – New users can only register by an invitation from an existing user.
  • manual_approval – New users can submit requests to the server staff and can only register after their request has been accepted.
api_versions
object

Information about the API versions that this server supports. The version numbers have the format of major.minor.

It is intended that forks will add their own fields to this object, enabling apps to easily discover which extensions this server supports and which versions they are.

smithereen
string

The maximum core Smithereen API version supported by this server.

uploads
object

Information about the limitations that this server imposes on uploaded files.

image_max_size
integer

The maximum size of an image file in bytes.

image_max_dimensions
integer

The maximum image dimensions, on each side, in pixels.

image_types
array of strings

The MIME types of image formats supported by this server.

stats
object

Server statistics.

users
integer

How many local user accounts exist on this server.

active_users
integer

How many of the local users have been active in the last month.

groups
integer

How many local groups exist on this server.

Errors

Global errors may occur when calling this method.