#Admin API

The Admin API provides endpoints for server administration. All endpoints require admin privileges.

#User Lookup (Whois)

GET /_matrix/client/v3/admin/whois/{userId}

Returns information about a user including device IDs and sessions.

{
  "user_id": "@alice:localhost",
  "devices": {
    "ABCDEF": {
      "device_id": "ABCDEF",
      "display_name": "Element Web",
      "last_seen_ts": 1625000000000,
      "last_seen_ip": "127.0.0.1"
    }
  }
}

#List Users

GET /_matrix/client/v3/admin/users

Returns all registered users.

#List Rooms

GET /_matrix/client/v3/admin/rooms

Returns all rooms with member counts and state summary.

#Kick User

POST /_matrix/client/v3/admin/rooms/{roomId}/kick

{
  "user_id": "@bob:localhost",
  "reason": "Violation of room rules"
}

#Ban User

POST /_matrix/client/v3/admin/rooms/{roomId}/ban

{
  "user_id": "@bob:localhost",
  "reason": "Spam"
}

#Deactivate User

POST /_matrix/client/v3/admin/users/{userId}/deactivate

Deactivates a user account, preventing further logins.

#Room Purge

POST /_matrix/client/v3/admin/rooms/{roomId}/purge

Removes all events and state from a room. Use with extreme caution.

#User Block/Unblock

POST /_matrix/client/v3/admin/users/{userId}/block
POST /_matrix/client/v3/admin/users/{userId}/unblock

Block a user from interacting with the server.

#Health Check Endpoints

These endpoints do not require authentication:

#Rate Limiting

GET /_matrix/client/v3/admin/rate-limits
POST /_matrix/client/v3/admin/rate-limits

View and configure per-IP rate limits. Default: 100 requests per 60-second window.