Settings

Prev Next

Use the Settings APIs to configure, secure, and manage your Rocket.Chat workspace. These endpoints provide administrative control over workspace behavior, infrastructure, security policies, and user management.

Settings API

  • Update workspace settings programmatically.

  • Retrieve public and private settings.

  • View settings modified within a specific timeframe.

Cloud API

  • Register and connect your workspace to Rocket.Chat Cloud  services.

  • Manually register a workspace if it was not registered during deployment.

DNS API

  • Resolve DNS records for a hostname.

  • Retrieve TXT and URL records.

End-to-End Encryption (E2E) API

  • Configure and manage encryption keys for users and rooms.

  • Retrieve keys and identify rooms without encryption enabled.

See the E2EE configuration user guides for more details.

Import and Bulk User Import APIs

  • Upload import files containing users, rooms, and related data.

  • Track import progress and review file details

See the Data Migration documentation for more details.

Instances API

  • Retrieve details about the instances running in your workspace.

Federation API

  • Add and manage federated servers.

  • Search for and join public rooms across federated environments.

Moderation API

  • View reported messages and their metadata.

  • Dismiss or delete reports as needed.

See the Moderation user guide for more details.

Device Management API

  • View active and historical user sessions.

  • Log out sessions remotely when necessary.

See the Device Management user guide for more details.

Password Policy API

  • Retrieve the configured password policy to validate compliance.

See the Password Policy user guide for more details.