SystemApi class

Constructors

SystemApi(Dio _dio, Serializers _serializers)
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

checkIntegrity({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<IntegrityCheckResult>>>
Perform a database integrity check 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.
clearServerBusy({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Clears the server busy (high load) flag 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.
databaseRecycle({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Recycle database connections Recycle database connections by closing and reconnecting all connections to master and read replica databases. ##### Permissions Must have `manage_system` permission.
generateSupportPacket({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Download a zip file which contains helpful and useful information for troubleshooting your mattermost instance. 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.
getAnalyticsOld({String? name = 'standard', String? teamId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Get analytics 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.
getAudits({int? page = 0, int? perPage = 60, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Audit>>>
Get audits 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.
getClientConfig({required String format, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Get client configuration Get a subset of the server configuration needed by the client. ##### Permissions No permission required.
getClientLicense({required String format, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Get client license Get a subset of the server license needed by the client. ##### Permissions No permission required but having the `manage_system` permission returns more information.
getConfig({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Config>>
Get configuration Retrieve the current server configuration ##### Permissions Must have `manage_system` permission.
getEnvironmentConfig({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<EnvironmentConfig>>
Get configuration made through environment variables 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.
getImageByUrl({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Uint8List>>
Get an image by url Fetches an image via Mattermost image proxy. Minimum server version: 3.10 ##### Permissions Must be logged in.
getLogs({int? page = 0, String? logsPerPage = '10000', CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<String>>>
Get logs Get a page of server logs, selected with `page` and `logs_per_page` query parameters. ##### Permissions Must have `manage_system` permission.
getNotices({required String clientVersion, required String client, required String teamId, String? locale, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Notice>>>
Get notices for logged in user in specified team 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.
getPing({bool? getServerStatus, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<SystemStatusResponse>>
Check system health 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 ##### Permissions Must be logged in.
getRedirectLocation({required String url, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<InlineResponse20010>>
Get redirect location Minimum server version: 3.10 ##### Permissions Must be logged in.
getServerBusyExpires({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<ServerBusy>>
Get server busy expiry time. 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.
getSupportedTimezone({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<String>>>
Retrieve a list of supported timezones Minimum server version: 3.10 ##### Permissions Must be logged in.
getWarnMetricsStatus({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Get the warn metrics status (enabled or disabled) 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 &quot;true&quot;, which means that they are in a &quot;warnable&quot; 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.
invalidateCaches({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Invalidate all the caches 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.
markNoticesViewed({required BuiltList<String> requestBody, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Update notices as 'viewed' Will mark the specified notices as 'viewed' by the logged in user. Minimum server version: 5.26 ##### Permissions Must be logged in.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patchConfig({required Config config, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Config>>
Patch configuration 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
postLog({required InlineObject70 inlineObject70, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<String>>>
Add log message 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`.
reloadConfig({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Reload configuration Reload the configuration file to pick up on any changes made to it. ##### Permissions Must have `manage_system` permission.
removeLicenseFile({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Remove license file 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 license renewal link 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.
requestTrialLicense({required InlineObject69 inlineObject69, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Request and install a trial license for your server Request and install a trial license for your server Minimum server version: 5.25 ##### Permissions Must have `manage_system` permission.
restartServer({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Restart the system after an upgrade from Team Edition to Enterprise Edition It restarts the current running mattermost instance to execute the new Enterprise binary. Minimum server version: 5.27 ##### Permissions Must have `manage_system` permission.
sendTrialLicenseWarnMetricAck({required String warnMetricId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Request trial license and acknowledge a warning of a metric status 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 &quot;ack&quot; status for all the warn metrics in the system. Minimum server version: 5.28 ##### Permissions Must have `manage_system` permission.
sendWarnMetricAck({required String warnMetricId, required InlineObject71 inlineObject71, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Acknowledge a warning of a metric status 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 &quot;ack&quot; status for all the warn metrics in the system. Minimum server version: 5.26 ##### Permissions Must have `manage_system` permission.
setServerBusy({String? seconds = '3600', CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Set the server busy (high load) flag 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.
testEmail({required Config config, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Send a test email 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.
testS3Connection({required Config config, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Test AWS S3 connection 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
testSiteURL({required InlineObject67 inlineObject67, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Checks the validity of a Site URL Sends a Ping request to the mattermost server using the specified Site URL. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.16
toString() → String
A string representation of this object.
inherited
trialLicensePrevGet({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Get last trial license used Get the last trial license used on the sevrer Minimum server version: 5.36 ##### Permissions Must have `manage_systems` permissions.
updateConfig({required Config config, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Config>>
Update configuration 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. ##### Permissions Must have `manage_system` permission.
updateMarketplaceVisitedByAdmin({required System system, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Stores that the Plugin Marketplace has been visited by at least an admin. 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.
upgradeToEnterprise({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PushNotification>>
Executes an inplace upgrade from Team Edition to Enterprise Edition 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.
upgradeToEnterpriseStatus({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<InlineResponse20011>>
Get the current status for the inplace upgrade from Team Edition to Enterprise Edition 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.
uploadLicenseFile({required MultipartFile license, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Upload license file Upload a license to enable enterprise features. Minimum server version: 4.0 ##### Permissions Must have `manage_system` permission.

Operators

operator ==(Object other) → bool
The equality operator.
inherited