DoRoutes API · version 1

Service

GET/v1/health

Answers 503 with {"status": "unavailable"} when the database cannot be reached.

Done.

Example response 200

{
  "status": "ok"
}

Something failed on our side.

errorobject, required
- codestring, required
  A short machine-readable name, such as not_found.
- messagestring, required
  What went wrong, for people.
request_idstring, required
Matches the X-Request-ID response header.

Example response 500

{
  "error": {
    "code": "string",
    "message": "string"
  },
  "request_id": "string"
}

The database cannot be reached.

Example response 503

{
  "status": "unavailable"
}

GET/v1/tenants/{slug}

Done.

tenantobject, required
- slugstring, required
- namestring, required
- keystring, required
  Send as X-Tenant-Key on every other request.

Example response 200

{
  "tenant": {
    "slug": "string",
    "name": "string",
    "key": "string"
  }
}

The request is not valid.

Not found, or not yours.

Something failed on our side.