media server logo
PricingSign inStart in the cloud for free
API docsOverview
General settings
Ports
Cluster nodes
Additional utilities
Storages
Toggle documentation navigation
Callaba home

General settings

Use General settings to configure the Engine hostname and HTTPS certificate, synchronize time, change instance-wide options, and back up or restore configuration.

What it doesApply Engine-wide settings

Choose this whenYou are changing instance-wide hostname, TLS, time, backup, or restore settings—not a media workflow.

Use another module whenUse the owning media module for a single stream, player, recording, route, or room.

1Read settings2Update values3Confirm state
POST /api/application/getAppInfo
7 endpoints

Before you start

getAppInfo is a public read method. Configuration, certificate, export, and import operations require a valid x-access-token. Use an account with administrative responsibility for the instance and back up current settings before changing connectivity or importing a database.

What you can do

  • getAppInfo reads application and instance information.
  • updateHttpConfig changes HTTP and hostname settings.
  • updateSslCertificate installs or replaces TLS material.
  • updateCustomSettings changes supported instance options.
  • updateNtpConfiguration configures time synchronization.
  • exportDb and importDb support configuration backup and restore.

Example workflow

  1. Read application information and export the current database.
  2. Update the hostname and HTTP configuration.
  3. Install the matching TLS certificate.
  4. Verify the dashboard and API on the final HTTPS address.

Common use cases

  • Move an Engine instance from an IP address to a production hostname.
  • Rotate an expiring TLS certificate without rebuilding media workflows.
  • Back up configuration before an upgrade or infrastructure change.

Limits and troubleshooting

An incorrect hostname, certificate, or HTTP configuration can make the instance unreachable. Database import can replace existing configuration, so validate the backup and maintenance window first. Keep system time synchronized because certificates, tokens, and distributed workflows depend on it.

Next steps

After connectivity is stable, configure Ports, Cluster nodes, or the ingest module needed by the workflow.

REST solution recipe

Configure the Engine HTTP and TLS boundary

Read the current application settings, choose the required HTTP mode, and install the certificate used by API and media-facing services.

  1. Read current settingsCapture the current mode and application state before changing the listener.POST /api/application/getAppInfo
  2. Set the HTTP modeApply the reviewed HTTP or HTTPS listener configuration.POST /api/application/updateHTTPConfig
  3. Install the certificateUpdate the certificate material only after its names and chain are verified.POST /api/application/updateSSLCertificate

Changing HTTP or certificates can interrupt active clients. Validate DNS, certificate chain, ports, and rollback access before applying it.

POST
/api/application/getAppInfo
Public endpoint

Use this public bootstrap call to inspect Callaba Engine application details before making instance-wide changes. No API token is required.

The response includes node_app, stack_version_name, stack_version, custom_settings, http_modes, needLicenceKey, conference URLs under global_module_settings, and read_preference.

The success field is spelled suceess. Clients must read that exact response field.

Request body parameters
This method has no parameters
Get app info
Copy code
curl --request POST \
  --url http://localhost/api/application/getAppInfo \
  --header 'Content-Type: application/json' \
  --data '{}'
Response
Versioning
node_app / stack_version_name / stack_version
mixed
Copy direct link

Current deployment flavor and stack version fields read from the application record and environment.

Delivery
http_modes
array
Copy direct link

Current HTTP delivery modes stored on the application record.

Custom settings
custom_settings
object
Copy direct link

Persisted custom application settings.

Licensing
needLicenceKey
boolean
Copy direct link

Indicates whether the application record currently has no licence key.

Video calls
global_module_settings.MODULE_CONFERENCES
object
Copy direct link

Current wss_server_url and turn_server_url values for conference connectivity.

Database
read_preference
string
Copy direct link

Resolved database read preference; the backend falls back to its primary-read constant.

Operation result
suceess
boolean
Copy direct link

The live backend currently returns this misspelled field with value true.

Response: Get app info
JSON
Copy code
{
  "node_app": "NODE_APP_SELF_HOSTED",
  "stack_version_name": "stable",
  "stack_version": "8.2",
  "custom_settings": {
    "showBrandName": false,
    "useCustomLogo": true
  },
  "http_modes": [
    {
      "mode": "HTTPS"
    },
    {
      "mode": "HTTP"
    }
  ],
  "needLicenceKey": false,
  "global_module_settings": {
    "MODULE_CONFERENCES": {
      "wss_server_url": "wss://video.example.com:443",
      "turn_server_url": "turn:turn.example.com:3478"
    }
  },
  "read_preference": "primary",
  "suceess": true
}
POST
/api/application/updateHTTPConfig
API token required
POST
/api/application/updateSSLCertificate
API token required
POST
/api/application/updateCustomSettings
API token required
POST
/api/application/importDb
API token required
POST
/api/application/exportDb
API token required
POST
/api/application/updateNTPConfiguration
API token required
Next toPorts