Skip to content

Latest commit

 

History

History
179 lines (131 loc) · 6.26 KB

endpoints.md

File metadata and controls

179 lines (131 loc) · 6.26 KB
Raw

List of implemented endpoints

This list was generated by the load-docs.p6 script that gets the data from the api-docs.json from matrix.org. This will give you an overview about what's implemented in the library.

Application service room directory management

  • PUT - /_matrix/client/r0/directory/list/appservice/{networkId}/{roomId}

Capabilities

  • GET - /_matrix/client/r0/capabilities

Device management

  • DELETE - /_matrix/client/r0/devices/{deviceId}
  • GET - /_matrix/client/r0/devices
  • GET - /_matrix/client/r0/devices/{deviceId}
  • POST - /_matrix/client/r0/delete_devices
  • PUT - /_matrix/client/r0/devices/{deviceId}

End-to-end encryption

  • GET - /_matrix/client/r0/keys/changes
  • POST - /_matrix/client/r0/keys/claim
  • POST - /_matrix/client/r0/keys/query
  • POST - /_matrix/client/r0/keys/upload

Media

  • GET - /_matrix/media/r0/config
  • GET - /_matrix/media/r0/download/{serverName}/{mediaId}
  • GET - /_matrix/media/r0/download/{serverName}/{mediaId}/{fileName}
  • GET - /_matrix/media/r0/preview_url
  • GET - /_matrix/media/r0/thumbnail/{serverName}/{mediaId}
  • POST - /_matrix/media/r0/upload

OpenID

  • POST - /_matrix/client/r0/user/{userId}/openid/request_token

Presence

  • GET - /_matrix/client/r0/presence/{userId}/status
  • PUT - /_matrix/client/r0/presence/{userId}/status

Push notifications

  • DELETE - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
  • GET - /_matrix/client/r0/notifications
  • GET - /_matrix/client/r0/pushers
  • GET - /_matrix/client/r0/pushrules/
  • GET - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
  • GET - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions
  • GET - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled
  • POST - /_matrix/client/r0/pushers/set
  • PUT - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}
  • PUT - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions
  • PUT - /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled

Read Markers

  • POST - /_matrix/client/r0/rooms/{roomId}/read_markers

Reporting content

  • POST - /_matrix/client/r0/rooms/{roomId}/report/{eventId}

Room creation

  • POST - /_matrix/client/r0/createRoom

Room directory

  • DELETE - /_matrix/client/r0/directory/room/{roomAlias}
  • GET - /_matrix/client/r0/directory/room/{roomAlias}
  • GET - /_matrix/client/r0/rooms/{roomId}/aliases
  • PUT - /_matrix/client/r0/directory/room/{roomAlias}

Room discovery

  • GET - /_matrix/client/r0/publicRooms
  • POST - /_matrix/client/r0/publicRooms

Room membership

  • GET - /_matrix/client/r0/joined_rooms
  • POST - /_matrix/client/r0/join/{roomIdOrAlias}
  • POST - /_matrix/client/r0/rooms/{roomId}/ban
  • POST - /_matrix/client/r0/rooms/{roomId}/forget
  • POST - /_matrix/client/r0/rooms/{roomId}/invite
  • POST - /_matrix/client/r0/rooms/{roomId}/invite
  • POST - /_matrix/client/r0/rooms/{roomId}/join
  • POST - /_matrix/client/r0/rooms/{roomId}/kick
  • POST - /_matrix/client/r0/rooms/{roomId}/leave
  • POST - /_matrix/client/r0/rooms/{roomId}/unban

Room participation

  • GET - /_matrix/client/r0/events
  • GET - /_matrix/client/r0/events/{eventId}
  • GET - /_matrix/client/r0/initialSync
  • GET - /_matrix/client/r0/rooms/{roomId}/context/{eventId}
  • GET - /_matrix/client/r0/rooms/{roomId}/event/{eventId}
  • GET - /_matrix/client/r0/rooms/{roomId}/initialSync
  • GET - /_matrix/client/r0/rooms/{roomId}/joined_members
  • GET - /_matrix/client/r0/rooms/{roomId}/members
  • GET - /_matrix/client/r0/rooms/{roomId}/messages
  • GET - /_matrix/client/r0/rooms/{roomId}/state
  • GET - /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}
  • GET - /_matrix/client/r0/sync
  • GET - /_matrix/client/r0/user/{userId}/filter/{filterId}
  • POST - /_matrix/client/r0/rooms/{roomId}/receipt/{receiptType}/{eventId}
  • POST - /_matrix/client/r0/user/{userId}/filter
  • PUT - /_matrix/client/r0/rooms/{roomId}/redact/{eventId}/{txnId}
  • PUT - /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}
  • PUT - /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}
  • PUT - /_matrix/client/r0/rooms/{roomId}/typing/{userId}

Room upgrades

  • POST - /_matrix/client/r0/rooms/{roomId}/upgrade

Search

  • POST - /_matrix/client/r0/search

Send-to-Device messaging

  • PUT - /_matrix/client/r0/sendToDevice/{eventType}/{txnId}

Server administration

  • GET - /.well-known/matrix/client
  • GET - /_matrix/client/r0/admin/whois/{userId}
  • GET - /_matrix/client/versions

Session management

  • GET - /_matrix/client/r0/login
  • POST - /_matrix/client/r0/login
  • POST - /_matrix/client/r0/logout
  • POST - /_matrix/client/r0/logout/all

User data

  • DELETE - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag}
  • GET - /_matrix/client/r0/account/3pid
  • GET - /_matrix/client/r0/account/whoami
  • GET - /_matrix/client/r0/profile/{userId}
  • GET - /_matrix/client/r0/profile/{userId}/avatar_url
  • GET - /_matrix/client/r0/profile/{userId}/displayname
  • GET - /_matrix/client/r0/register/available
  • GET - /_matrix/client/r0/user/{userId}/account_data/{type}
  • GET - /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}
  • GET - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags
  • POST - /_matrix/client/r0/account/3pid
  • POST - /_matrix/client/r0/account/3pid/bind
  • POST - /_matrix/client/r0/account/3pid/delete
  • POST - /_matrix/client/r0/account/3pid/unbind
  • POST - /_matrix/client/r0/account/deactivate
  • POST - /_matrix/client/r0/account/password
  • POST - /_matrix/client/r0/register
  • POST - /_matrix/client/r0/user_directory/search
  • PUT - /_matrix/client/r0/profile/{userId}/avatar_url
  • PUT - /_matrix/client/r0/profile/{userId}/displayname
  • PUT - /_matrix/client/r0/user/{userId}/account_data/{type}
  • PUT - /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}
  • PUT - /_matrix/client/r0/user/{userId}/rooms/{roomId}/tags/{tag}

VOIP

  • GET - /_matrix/client/r0/voip/turnServer

Endpoint completion

0.456311% - (47/103)