Skip to content

REST API

Client updates & config

Update policy for native clients, desktop auto-update feed and realtime connection settings.

Public endpoints used by the official apps. You can use client-updates to check the latest Android/desktop build.

Endpoints#

GET /api/broadcasting/client-config #

Realtime connection settings

Bearer token

Reverb (Pusher protocol) key/host/port/scheme. {enabled:false} when realtime is off.

Parameters

No parameters.

Request

curl
curl 'https://minchatapp.com/api/broadcasting/client-config' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Accept: application/json'

Response

HTTP 200
{
  "enabled": false
}
GET /api/client-updates #

Check for client updates

No auth Rate limit: 60/min

Public. update: none, soft or force (below min_supported).

Parameters

Name Type Description
platform
required query
string
android, desktop-mac, desktop-win, desktop-linux.
current
optional query
string
Current semver.
version_code
optional query
integer
Android versionCode (preferred on Android).
channel
optional query
string
Release channel, default stable.

Request

curl
curl 'https://minchatapp.com/api/client-updates?platform=…' \
  -H 'Accept: application/json'

Response

HTTP 200 · desktop
{
  "platform": "desktop-mac",
  "channel": "stable",
  "latest": null,
  "min_supported": null,
  "update": "none",
  "store_url": null
}
200 HTTP 200
HTTP 200
{
  "platform": "android",
  "channel": "stable",
  "latest": null,
  "min_supported": null,
  "update": "none",
  "store_url": null
}
GET /client-updates/desktop/{channel}/{file} #

Desktop auto-update feed

No auth

electron-updater generic feed: latest-mac.yml, latest.yml (Windows), latest-linux.yml.

Parameters

Name Type Description
channel
required path
string
Release channel (stable).
file
required path
string
latest-mac.yml, latest.yml or latest-linux.yml.

Request

curl
curl 'https://minchatapp.com/client-updates/desktop/stable/latest-mac.yml' \
  -H 'Accept: application/json'

Response

Responds with HTTP 200.

GET /client-updates/download/{release} #

Download a client build

No auth

Binary referenced by latest.url.

Parameters

Name Type Description
release
required path
integer
Release id.

Request

curl
curl 'https://minchatapp.com/client-updates/download/51' \
  -H 'Accept: application/json'

Response

Responds with HTTP 200.