Merran documentation API & integrations

Check the server can do its work

GET

/api/health/ready

const url = 'http://localhost:3000/api/health/ready';
const options = {method: 'GET'};

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

curl --request GET \
  --url http://localhost:3000/api/health/ready

Checks the database answers and is up to date. For uptime monitors. Needs no sign-in.

Responses

200

Ready.

application/json

object

status

required

string

Allowed values: ready

database

required

string

Allowed values: sqlite postgres

Example

{
  "status": "ready",
  "database": "sqlite"
}

503

Not ready: the database is unreachable or out of date.

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."
    }
  }
}