Performs a database integrity check. Note: This check may temporarily harm system performance. Minimum server version: 5.28.0 Local mode only: This endpoint is only available through local mode.
Marks the server as not having high load which re-enables non-critical services such as search, statuses and typing notifications. Minimum server version: 5.20 ##### Permissions Must have manage_system permission.
Recycle database connections by closing and reconnecting all connections to master and read replica databases. ##### Permissions Must have manage_system permission.
Download a zip file which contains helpful and useful information for troubleshooting your mattermost instance. Minimum server version: 5.32 ##### Permissions Must have any of the system console read permissions. ##### License Requires either a E10 or E20 license.
Get some analytics data about the system. This endpoint uses the old format, the /analytics route is reserved for the new format when it gets implemented. The returned JSON changes based on the name query parameter but is always key/value pairs. Minimum server version: 4.0 ##### Permissions Must have manage_system permission.
Get a page of audits for all users on the system, selected with page and per_page query parameters. ##### Permissions Must have manage_system permission.
Get a subset of the server license needed by the client. ##### Permissions No permission required but having the manage_system permission returns more information.
Retrieve a json object mirroring the server configuration where fields are set to true if the corresponding config setting is set through an environment variable. Settings that haven’t been set through environment variables will be missing from the object. Minimum server version: 4.10 ##### Permissions Must have manage_system permission.
Will return appropriate product notices for current user in the team specified by teamId parameter. Minimum server version: 5.26 ##### Permissions Must be logged in.
Check if the server is up and healthy based on the configuration setting GoRoutineHealthThreshold. If GoRoutineHealthThreshold and the number of goroutines on the server exceeds that threshold the server is considered unhealthy. If GoRoutineHealthThreshold is not set or the number of goroutines is below the threshold the server is considered healthy. Minimum server version: 3.10 If a "device_id" is passed in the query, it will test the Push Notification Proxy in order to discover whether the device is able to receive notifications. The response will have a "CanReceiveNotifications" property with one of the following values: - true: It can receive notifications - false: It cannot receive notifications - unknown: There has been an unknown error, and it is not certain whether it can receive notifications. Minimum server version: 6.5 ##### Permissions None.
Gets the timestamp corresponding to when the server busy flag will be automatically cleared. Minimum server version: 5.20 ##### Permissions Must have manage_system permission.
Get the status of a set of metrics (enabled or disabled) from the Systems table. The returned JSON contains the metrics that we need to warn the admin on with regard to their status (we return the ones whose status is "true", which means that they are in a "warnable" state - e.g. a threshold has been crossed or some other condition has been fulfilled). Minimum server version: 5.26 ##### Permissions Must have manage_system permission.
Purge all the in-memory caches for the Mattermost server. This can have a temporary negative effect on performance while the caches are re-populated. ##### Permissions Must have manage_system permission.
Submit configuration to patch. As of server version 4.8, the PluginSettings.EnableUploads setting cannot be modified by this endpoint. ##### Permissions Must have manage_system permission. Minimum server version: 5.20 ##### Note The Plugins are stored as a map, and since a map may recursively go down to any depth, individual fields of a map are not changed. Consider using the update config (PUT api/v4/config) endpoint to update a plugins configurations.
Add log messages to the server logs. ##### Permissions Users with manage_system permission can log ERROR or DEBUG messages. Logged in users can log ERROR or DEBUG messages when ServiceSettings.EnableDeveloper is true or just DEBUG messages when false. Non-logged in users can log ERROR or DEBUG messages when ServiceSettings.EnableDeveloper is true and cannot log when false.
Remove the license file from the server. This will disable all enterprise features. Minimum server version: 4.0 ##### Permissions Must have manage_system permission.
Request the renewal link that would be used to start the license renewal process Minimum server version: 5.32 ##### Permissions Must have sysconsole_write_about permission.
It restarts the current running mattermost instance to execute the new Enterprise binary. Minimum server version: 5.27 ##### Permissions Must have manage_system permission.
Request a trial license and acknowledge a warning for the warn_metric_id metric crossing a threshold (or some similar condition being fulfilled) - sets the "ack" status for all the warn metrics in the system. Minimum server version: 5.28 ##### Permissions Must have manage_system permission.
Acknowledge a warning for the warn_metric_id metric crossing a threshold (or some similar condition being fulfilled) - attempts to send an ack email to acknowledge@mattermost.com and sets the "ack" status for all the warn metrics in the system. Minimum server version: 5.26 ##### Permissions Must have manage_system permission.
Marks the server as currently having high load which disables non-critical services such as search, statuses and typing notifications. Minimum server version: 5.20 ##### Permissions Must have manage_system permission.
Send a test email to make sure you have your email settings configured correctly. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested. ##### Permissions Must have manage_system permission.
Send a test to validate if can connect to AWS S3. Optionally provide a configuration in the request body to test. If no valid configuration is present in the request body the current server configuration will be tested. ##### Permissions Must have manage_system permission. Minimum server version: 4.8
Sends a Ping request to the mattermost server using the specified Site URL. ##### Permissions Must have manage_system permission. Minimum server version: 5.16
Submit a new configuration for the server to use. As of server version 4.8, the PluginSettings.EnableUploads setting cannot be modified by this endpoint. Note that the parameters that aren’t set in the configuration that you provide will be reset to default values. Therefore, if you want to change a configuration parameter and leave the other ones unchanged, you need to get the existing configuration first, change the field that you want, then put that new configuration. ##### Permissions Must have manage_system permission.
Stores the system-level status that specifies that at least an admin has visited the in-product Plugin Marketplace. Minimum server version: 5.33 ##### Permissions Must have manage_system permissions.
It downloads the Mattermost Enterprise Edition of your current version and replace your current version with it. After the upgrade you need to restart the Mattermost server. Minimum server version: 5.27 ##### Permissions Must have manage_system permission.
It returns the percentage of completion of the current upgrade or the error if there is any. Minimum server version: 5.27 ##### Permissions Must have manage_system permission.