Settings

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.

The setting object

Each workspace setting is a simple object identified by its _id. An example from Get Setting:

{
  "_id": "Livechat_enabled",
  "value": false,
  "success": true
}

Fields you use most often:

• _id: The setting ID. It matches the setting's identifier in the admin area, such as Site_Url or Accounts_AllowUserProfileChange.

• value: The current value. Its type depends on the setting: boolean, string, number, or object.

Settings API

• Update workspace settings programmatically.

• Retrieve public and private settings.

• View settings modified within a specific timeframe.

Read and update workspace settings

1. Get a setting by its ID, or get all public settings to read workspace configuration from a client.

2. Update the setting with the new value.

3. Update settings in bulk to change several settings in one request.

Configure a custom OAuth provider

1. Add a custom OAuth service, then set its URLs and credentials with the settings endpoints.

2. Get the OAuth settings or refresh the OAuth services to apply and verify the configuration.

3. Remove the custom OAuth service when it is no longer needed.

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.

Moderate reported content

1. Get reported messages and the reports of a message to review them.

2. Dismiss the reports, or delete the reported messages of a user.

Device Management API

• View active and historical user sessions.

• Log out sessions remotely when necessary.

See the Device Management user guide for more details.

Manage user sessions

1. Get all user sessions in the workspace, or the current user's sessions.

2. Log out a session remotely by its session ID.

Password Policy API

• Retrieve the configured password policy to validate compliance.

See the Password Policy user guide for more details.

Conventions

• Setting IDs match the identifiers shown in the workspace admin area, so you can look up a setting in the UI and manage it by the same ID through the API.

• Reading private settings and updating settings require admin permissions such as view-privileged-setting and edit-privileged-setting. Each endpoint page lists its required permissions.

• Get Public Settings returns only settings marked public and can be called without authentication.

• Sensitive administrative operations may require two-factor authentication headers.