Get global settings

Fetch global settings for a Zulip server.

GET https://dash.zulipchat.com/api/v1/server_settings

Note: this endpoint does not require any authentication at all, and you can use it to check:

  • If this is a Zulip server, and if so, what version of Zulip it's running.
  • What a Zulip client (e.g. a mobile app or zulip-terminal) needs to know in order to display a login prompt for the server (e.g. what authentication methods are available).

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Fetch the settings for this server
result = client.get_server_settings()
print(result)

curl -sSX GET -G https://dash.zulipchat.com/api/v1/server_settings \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Arguments

This endpoint does not consume any arguments.

Response

Return values

  • authentication_methods: object in which each key-value pair in the object indicates whether the authentication method is enabled on this server.
  • zulip_version: the version of Zulip running in the server.
  • push_notifications_enabled: whether mobile/push notifications are enabled.
  • is_incompatible: whether the Zulip client that has sent a request to this endpoint is deemed incompatible with the server.
  • email_auth_enabled: setting for allowing users authenticate with an email-password combination.
  • require_email_format_usernames: whether usernames should have an email address format. This is important for clients to know whether the validate email address format in a login prompt; this value will be false if the server has LDAP authentication enabled with a username and password combination.
  • realm_uri: the organization's canonical URI.
  • realm_name: the organization's name (for display purposes).
  • realm_icon: the URI of the organization's logo as a square image, used for identifying the organization in small locations in the mobile and desktop apps.
  • realm_description: HTML description of the organization, as configured by the organization profile.
  • external_authentication_methods: list of dictionaries describing the available external authentication methods (such as google/github/SAML) enabled for this organization. Each dictionary specifies the name and icon that should be displayed on the login buttons (display_name and display_icon, where display_icon can be null, if no icon is to be displayed), the URLs that should be accessed to initiate login/signup using the method (login_url and signup_url) and name, which is a unique, stable, machine-readable name for the authentication method. The list is sorted in the order in which these authentication methods should be displayed.

Please note that not all of these attributes are guaranteed to appear in a response, for two reasons:

  • This endpoint has evolved over time, so responses from older Zulip servers might be missing some keys (in which case a client should assume the appropriate default).
  • If a /server_settings request is made to the root domain of a multi-subdomain server, like the root domain of zulipchat.com, the settings that are realm-specific are not known and thus not provided.

Example response

A typical successful JSON response for a single-organization server may look like:

{
    "authentication_methods": {
        "azuread": false,
        "dev": true,
        "email": true,
        "github": true,
        "google": true,
        "ldap": false,
        "password": true,
        "remoteuser": false,
        "saml": true
    },
    "email_auth_enabled": true,
    "external_authentication_methods": [
        {
            "display_icon": null,
            "display_name": "SAML",
            "login_url": "/accounts/login/social/saml/idp_name",
            "name": "saml:idp_name",
            "signup_url": "/accounts/register/social/saml/idp_name"
        },
        {
            "display_icon": "/static/images/landing-page/logos/googl_e-icon.png",
            "display_name": "Google",
            "login_url": "/accounts/login/social/google",
            "name": "google",
            "signup_url": "/accounts/register/social/google"
        },
        {
            "display_icon": "/static/images/landing-page/logos/github-icon.png",
            "display_name": "GitHub",
            "login_url": "/accounts/login/social/github",
            "name": "github",
            "signup_url": "/accounts/register/social/github"
        }
    ],
    "is_incompatible": false,
    "msg": "",
    "push_notifications_enabled": false,
    "realm_description": "<p>The Zulip development environment default organization.  It's great for testing!</p>",
    "realm_icon": "https://secure.gravatar.com/avatar/62429d594b6ffc712f54aee976a18b44?d=identicon",
    "realm_name": "Zulip Dev",
    "realm_uri": "http://localhost:9991",
    "require_email_format_usernames": true,
    "result": "success",
    "zulip_version": "2.0.6+git"
}