Overview
introduction
schema
APIv3 Deprecation
Standard Features
drivers
authentication
post
Migrate user accounts authentication type to LDAP.
post
Migrate user accounts authentication type to SAML.
errors
rate limiting
WebSocket
Endpoints
users
post
Login to Mattermost server
post
Auto-Login to Mattermost server using CWS token
post
Logout from the Mattermost server
post
Create a user
get
Get users
del
Permanent delete all users
post
Get users by ids
post
Get users by group channels ids
post
Get users by usernames
post
Search users
get
Autocomplete users
get
Get user IDs of known users
get
Get total count of users in the system
get
Get total count of users in the system matching the specified filters
get
Get a user
put
Update a user
del
Deactivate a user account.
put
Patch a user
put
Update a user's roles
put
Update user active status
get
Get user's profile image
post
Set user's profile image
del
Delete user's profile image
get
Return user's default (generated) profile image
get
Get a user by username
post
Reset password
put
Update a user's MFA
post
Generate MFA secret
post
Demote a user to a guest
post
Promote a guest to user
post
Convert a user into a bot
post
Check MFA
put
Update a user's password
post
Send password reset email
get
Get a user by email
get
Get user's sessions
post
Revoke a user session
post
Revoke all active sessions for a user
put
Attach mobile device
get
Get user's audits
post
Verify user email by ID
post
Verify user email
post
Send verification email
post
Switch login method
post
Create a user access token
get
Get user access tokens
get
Get user access tokens
post
Revoke a user access token
get
Get a user access token
post
Disable personal access token
post
Enable personal access token
post
Search tokens
put
Update a user's authentication method
post
Records user action when they accept or decline custom terms of service
get
Fetches user's latest terms of service action if the latest action was for acceptance.
post
Revoke all sessions from all users.
post
Publish a user typing websocket event.
get
Get uploads for a user
get
Get all channel members from all teams for a user
post
Migrate user accounts authentication type to LDAP.
post
Migrate user accounts authentication type to SAML.
post
Convert a bot into a user
bots
post
Convert a user into a bot
post
Create a bot
get
Get bots
put
Patch a bot
get
Get a bot
post
Disable a bot
post
Enable a bot
post
Assign a bot to a user
get
Get bot's LHS icon
post
Set bot's LHS icon image
del
Delete bot's LHS icon image
post
Convert a bot into a user
teams
post
Create a team
get
Get teams
get
Get a team
put
Update a team
del
Delete a team
put
Patch a team
put
Update teams's privacy
post
Restore a team
get
Get a team by name
post
Search teams
get
Check if team exists
get
Get a user's teams
get
Get team members
post
Add user to team
post
Add user to team from invite
post
Add multiple users to team
get
Get team members for a user
get
Get a team member
del
Remove user from team
post
Get team members by ids
get
Get a team stats
post
Regenerate the Invite ID from a Team
get
Get the team icon
post
Sets the team icon
del
Remove the team icon
put
Update a team member roles
put
Update the scheme-derived roles of a team member.
get
Get team unreads for a user
get
Get unreads for a team
post
Invite users to the team by email
post
Invite guests to the team by email
del
Invalidate active email invitations
post
Import a Team from other application
get
Get invite info for a team
put
Set a team's scheme
get
Team members minus group members.
post
Search files in a team
channels
get
Get a list of all channels
post
Create a channel
post
Create a direct message channel
post
Create a group message channel
post
Search all private and open type channels across all teams
post
Search Group Channels
post
Get a list of channels by ids
get
Get timezones in a channel
get
Get a channel
put
Update a channel
del
Delete a channel
put
Patch a channel
put
Update channel's privacy
post
Restore a channel
post
Move a channel
get
Get channel statistics
get
Get a channel's pinned posts
get
Get public channels
get
Get private channels
get
Get deleted channels
get
Autocomplete channels
get
Autocomplete channels for search
post
Search channels
post
Search archived channels
get
Get a channel by name
get
Get a channel by name and team name
get
Get channel members
post
Add user to channel
post
Get channel members by ids
get
Get channel member
del
Remove user from channel
put
Update channel roles
put
Update the scheme-derived roles of a channel member.
put
Update channel notifications
post
View channel
get
Get channel memberships and roles for a user
get
Get channels for user
get
Get all channels from all teams
get
Get unread messages
put
Set a channel's scheme
get
Channel members minus group members.
get
Channel members counts for each group that has atleast one member in the channel
get
Get information about channel's moderation.
put
Update a channel's moderation settings.
get
Get user's sidebar categories
post
Create user's sidebar category
put
Update user's sidebar categories
get
Get user's sidebar category order
put
Update user's sidebar category order
get
Get sidebar category
put
Update sidebar category
del
Delete sidebar category
posts
post
Create a post
post
Create a ephemeral post
get
Get a post
del
Delete a post
put
Update a post
post
Mark as unread from a post.
put
Patch a post
get
Get a thread
get
Get a list of flagged posts
get
Get file info for post
get
Get posts for a channel
get
Get posts around oldest unread
post
Search for team posts
post
Pin a post to the channel
post
Unpin a post to the channel
post
Perform a post action
post
Get posts by a list of ids
post
Set a post reminder
threads
get
Get all threads that user is following
get
Get all unread mention counts from followed threads, per-channel
put
Mark all threads that user is following as read
put
Mark a thread that user is following read state to the timestamp
put
Start following a thread
del
Stop following a thread
get
Get a thread followed by the user
files
post
Upload a file
get
Get a file
get
Get a file's thumbnail
get
Get a file's preview
get
Get a public file link
get
Get metadata for a file
get
Get a public file
post
Search files in a team
uploads
post
Create an upload
get
Get an upload session
post
Perform a file upload
preferences
get
Get the user's preferences
put
Save the user's preferences
post
Delete user's preferences
get
List a user's preferences by category
get
Get a specific user preference
status
get
Get user status
put
Update user status
post
Get user statuses by id
put
Update user custom status
del
Unsets user custom status
del
Delete user's recent custom status
post
Delete user's recent custom status
emoji
post
Create a custom emoji
get
Get a list of custom emoji
get
Get a custom emoji
del
Delete a custom emoji
get
Get a custom emoji by name
get
Get custom emoji image
post
Search custom emoji
get
Autocomplete custom emoji
reactions
post
Create a reaction
get
Get a list of reactions to a post
del
Remove a reaction from a post
post
Bulk get the reaction for posts
webhooks
post
Create an incoming webhook
get
List incoming webhooks
get
Get an incoming webhook
del
Delete an incoming webhook
put
Update an incoming webhook
post
Create an outgoing webhook
get
List outgoing webhooks
get
Get an outgoing webhook
del
Delete an outgoing webhook
put
Update an outgoing webhook
post
Regenerate the token for the outgoing webhook.
commands
post
Create a command
get
List commands for a team
get
List autocomplete commands
get
List commands' autocomplete data
get
Get a command
put
Update a command
del
Delete a command
put
Move a command
put
Generate a new token
post
Execute a command
OpenGraph
post
Get open graph metadata for url
system
get
Retrieve a list of supported timezones
get
Check system health
get
Get notices for logged in user in specified team
put
Update notices as 'viewed'
post
Recycle database connections
post
Send a test email
post
Checks the validity of a Site URL
post
Test AWS S3 connection
get
Get configuration
put
Update configuration
post
Reload configuration
get
Get client configuration
get
Get configuration made through environment variables
put
Patch configuration
post
Upload license file
del
Remove license file
get
Get client license
get
Request the license renewal link
post
Request and install a trial license for your server
get
Get last trial license used
get
Get audits
post
Invalidate all the caches
get
Get logs
post
Add log message
get
Get analytics
post
Set the server busy (high load) flag
get
Get server busy expiry time.
del
Clears the server busy (high load) flag
get
Get redirect location
get
Get an image by url
post
Executes an inplace upgrade from Team Edition to Enterprise Edition
get
Get the current status for the inplace upgrade from Team Edition to Enterprise Edition
post
Restart the system after an upgrade from Team Edition to Enterprise Edition
get
Get the warn metrics status (enabled or disabled)
post
Acknowledge a warning of a metric status
post
Request trial license and acknowledge a warning of a metric status
post
Perform a database integrity check
get
Download a zip file which contains helpful and useful information for troubleshooting your mattermost instance.
