mattermost-clj.api.system — mattermost-clj 4.0.3

analytics-old-get clj

(analytics-old-get)

(analytics-old-get optional-params)

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.

analytics-old-get-with-http-info clj

(analytics-old-get-with-http-info)

(analytics-old-get-with-http-info {:keys [name team-id]})

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.

audits-get clj

(audits-get)

(audits-get optional-params)

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.

audits-get-with-http-info clj

(audits-get-with-http-info)

(audits-get-with-http-info {:keys [page per-page]})

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.

caches-invalidate-post clj

(caches-invalidate-post)

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.

caches-invalidate-post-with-http-info clj

(caches-invalidate-post-with-http-info)

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.

config-client-get clj

(config-client-get format)

Get client configuration Get a subset of the server configuration needed by the client.

Permissions

No permission required.

config-client-get-with-http-info clj

(config-client-get-with-http-info format)

Get client configuration Get a subset of the server configuration needed by the client.

Permissions

No permission required.

config-environment-get clj

(config-environment-get)

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.

config-environment-get-with-http-info clj

(config-environment-get-with-http-info)

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.

config-get clj

(config-get)

Get configuration Retrieve the current server configuration

Permissions

Must have manage_system permission.

config-get-with-http-info clj

(config-get-with-http-info)

Get configuration Retrieve the current server configuration

Permissions

Must have manage_system permission.

config-put clj

(config-put 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.

config-put-with-http-info clj

(config-put-with-http-info 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.

config-reload-post clj

(config-reload-post)

Reload configuration Reload the configuration file to pick up on any changes made to it.

Permissions

Must have manage_system permission.

config-reload-post-with-http-info clj

(config-reload-post-with-http-info)

Reload configuration Reload the configuration file to pick up on any changes made to it.

Permissions

Must have manage_system permission.

database-recycle-post clj

(database-recycle-post)

Recycle database connections Recycle database connections by closing and reconnecting all connections to master and read replica databases.

Permissions

Must have manage_system permission.

database-recycle-post-with-http-info clj

(database-recycle-post-with-http-info)

Recycle database connections Recycle database connections by closing and reconnecting all connections to master and read replica databases.

Permissions

Must have manage_system permission.

email-test-post clj

(email-test-post config)

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.

email-test-post-with-http-info clj

(email-test-post-with-http-info config)

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.

file-s3-test-post clj

(file-s3-test-post config)

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

file-s3-test-post-with-http-info clj

(file-s3-test-post-with-http-info config)

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

license-client-get clj

(license-client-get format)

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.

license-client-get-with-http-info clj

(license-client-get-with-http-info format)

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.

license-delete clj

(license-delete)

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.

license-delete-with-http-info clj

(license-delete-with-http-info)

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.

license-post clj

(license-post license)

Upload license file Upload a license to enable enterprise features.

Minimum server version: 4.0

Permissions

Must have manage_system permission.

license-post-with-http-info clj

(license-post-with-http-info license)

Upload license file Upload a license to enable enterprise features.

Minimum server version: 4.0

Permissions

Must have manage_system permission.

logs-get clj

(logs-get)

(logs-get optional-params)

Get logs Get a page of server logs, selected with page and logs_per_page query parameters.

Permissions

Must have manage_system permission.

logs-get-with-http-info clj

(logs-get-with-http-info)

(logs-get-with-http-info {:keys [page logs-per-page]})

Get logs Get a page of server logs, selected with page and logs_per_page query parameters.

Permissions

Must have manage_system permission.

logs-post clj

(logs-post)

(logs-post optional-params)

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.

logs-post-with-http-info clj

(logs-post-with-http-info)

(logs-post-with-http-info {:keys [inline-object-49]})

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.

site-url-test-post clj

(site-url-test-post)

(site-url-test-post optional-params)

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

site-url-test-post-with-http-info clj

(site-url-test-post-with-http-info)

(site-url-test-post-with-http-info {:keys [inline-object-48]})

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

system-ping-get clj

(system-ping-get)

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.

system-ping-get-with-http-info clj

(system-ping-get-with-http-info)

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.