Merran documentation API & integrations

Look for a newer Merran now

POST

/api/settings/server/updates/check

const url = 'http://localhost:3000/api/settings/server/updates/check';
const options = {
  method: 'POST',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/settings/server/updates/check \
  --cookie merran.session_token=<merran.session_token>

Server admins only. Asks GitHub for Merran’s releases now, rather than at the next 6-hourly look, and answers with what it found. Does nothing for a build that isn’t a release, or when MERRAN_UPDATE_CHECK says no.

Authorizations

session

Responses

200

What the update check found.

application/json

object

current

required

The version running.

string

devBuild

required

Not a release (from source, or the edge image), so it isn’t checked.

boolean

checking

required

It looks every 6 hours: on unless MERRAN_UPDATE_CHECK says no.

boolean

checkedAt

required

string | null format: date-time

error

required

Why the last look didn’t work, if it didn’t.

string | null

latest

required

The newest release this server would update to: pre-releases too when it runs one.

object

version

required

string

name

required

string

url

required

string

notes

required

In Markdown.

string

publishedAt

required

string | null

prerelease

required

boolean

newer

required

The latest is newer than what’s running.

boolean

installMethod

required

string

Allowed values: source docker

Example

{
  "current": "0.1.0-alpha.1",
  "devBuild": false,
  "checking": true,
  "checkedAt": "2026-10-20T18:53:00.000Z",
  "error": null,
  "latest": {
    "version": "0.1.0-alpha.2",
    "name": "Merran 0.1.0-alpha.2",
    "url": "https://github.com/merran-app/merran/releases/tag/v0.1.0-alpha.2",
    "notes": "## What's new\n\n- Send splits the list across your stores.",
    "publishedAt": "2026-10-20T16:00:00Z",
    "prerelease": true
  },
  "newer": true,
  "installMethod": "docker"
}

401

Not signed in.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

403

Not allowed.

application/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}