API Tags

---

This section enumerates the tags and their associated API.

accounts

• ban_account

• change_password

• check_account

• check_password

• check_password_hash

• delete_old_users

• delete_old_users_vhost

• register

• registered_users

• unban_ip

• unregister

acme

• list_certificates

• request_certificate

• revoke_certificate

cluster

• join_cluster

• leave_cluster

• list_cluster

• set_master

config

• convert_to_yaml

• dump_config

• reload_config

documentation

• gen_html_doc_for_commands

• gen_markdown_doc_for_commands

• gen_markdown_doc_for_tags

• man

ejabberdctl

• help

• mnesia_info_ctl

• print_sql_schema

erlang

• compile

• get_cookie

• restart_module

last

• get_last

• set_last

logs

• get_loglevel

• reopen_log

• rotate_log

• set_loglevel

mam

• remove_mam_for_user

• remove_mam_for_user_with_peer

mnesia

• backup

• delete_mnesia

• dump

• dump_table

• export2sql

• export_piefxis

• export_piefxis_host

• import_dir

• import_file

• import_piefxis

• import_prosody

• install_fallback

• load

• mnesia_change_nodename

• mnesia_info

• mnesia_info_ctl

• mnesia_table_info

• restore

modules

• module_check

• module_install

• module_uninstall

• module_upgrade

• modules_available

• modules_installed

• modules_update_specs

muc

• create_rooms_file

• destroy_rooms_file

• get_user_rooms

• get_user_subscriptions

• muc_online_rooms

• muc_online_rooms_by_regex

• muc_register_nick

• muc_unregister_nick

• rooms_empty_destroy

• rooms_empty_list

• rooms_unused_destroy

• rooms_unused_list

muc_room

• change_room_option

• create_room

• create_room_with_opts

• destroy_room

• get_room_affiliation

• get_room_affiliations

• get_room_history

• get_room_occupants

• get_room_occupants_number

• get_room_options

• get_subscribers

• send_direct_invitation

• set_room_affiliation

• subscribe_room

• subscribe_room_many

• unsubscribe_room

muc_sub

• create_room_with_opts

• get_subscribers

• get_user_subscriptions

• subscribe_room

• subscribe_room_many

• unsubscribe_room

oauth

• oauth_add_client_implicit

• oauth_add_client_password

• oauth_issue_token

• oauth_list_tokens

• oauth_remove_client

• oauth_revoke_token

offline

• get_offline_count

private

• bookmarks_to_pep

• private_get

• private_set

purge

• abort_delete_old_mam_messages

• abort_delete_old_messages

• delete_expired_messages

• delete_expired_pubsub_items

• delete_old_mam_messages

• delete_old_mam_messages_batch

• delete_old_mam_messages_status

• delete_old_messages

• delete_old_messages_batch

• delete_old_messages_status

• delete_old_pubsub_items

• delete_old_push_sessions

• delete_old_users

• delete_old_users_vhost

roster

• add_rosteritem

• delete_rosteritem

• get_roster

• process_rosteritems

• push_alltoall

• push_roster

• push_roster_all

s2s

• incoming_s2s_number

• outgoing_s2s_number

• stop_s2s_connections

server

• clear_cache

• gc

• halt

• registered_vhosts

• restart

• status

• stop

• stop_kindly

• update

• update_list

session

• connected_users

• connected_users_info

• connected_users_number

• connected_users_vhost

• get_presence

• kick_session

• kick_user

• num_resources

• resource_num

• set_presence

• status_list

• status_list_host

• status_num

• status_num_host

• user_resources

• user_sessions_info

shared_roster_group

• srg_create

• srg_delete

• srg_get_info

• srg_get_members

• srg_list

• srg_user_add

• srg_user_del

sql

• convert_to_scram

• import_prosody

• print_sql_schema

stanza

• privacy_set

• send_message

• send_stanza

• send_stanza_c2s

statistics

• connected_users_number

• incoming_s2s_number

• outgoing_s2s_number

• stats

• stats_host

• status_num

• status_num_host

v1

• add_rosteritem

• oauth_issue_token

• send_direct_invitation

• set_presence

• srg_create

• subscribe_room

• subscribe_room_many

vcard

• get_vcard

• get_vcard2

• get_vcard2_multi

• set_nickname

• set_vcard

• set_vcard2

• set_vcard2_multi