Operations

/ping

Simple boolean, always returns true in non-error states. Indicates the minimal functioning of the system as a whole. Use /health for a deeper diagnostic.

GET/ping

Base URL

curl

curl https://test-m1.minusonedb.com/ping

m1 client

m1 test-m1 ping

• rights: none
• verbs: GET
• parameters: none

▶200 OKReturns true when system is operational

true

/init

A POST will initialize a new environment; this operation can only be performed once. GET calls to /init will return a boolean indicating whether the system has been initialized.

POST/init

Base URL

username *

password *

bucket *

curl

curl https://test-m1.minusonedb.com/init

curl https://test-m1.minusonedb.com/init \
-d "username=admin&password=passphrase&bucket=m1-24e27632d234452ba37e60936c0e88eb"

m1 client

m1 test-m1 init

m1 test-m1 init -username admin -password passphrase -bucket m1-24e27632d234452ba37e60936c0e88eb

• rights: none
• verbs: GET or POST

Parameter	Type	Required
username	String	Yes
password	String	Yes
bucket	String	Yes

/health

Returns the status of all environment components.

GET/health

Base URLAuthorization Token

curl

curl https://test-m1.minusonedb.com/health \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 health

• rights: admin
• verbs: GET
• parameters: none

▶200 OKReturns status of all environment components

{
  "geo": {
    "status": "PASSED",
    "message": "Data loaded."
  },
  "sessions": {
    "status": "PASSED",
    "message": "",
    "details": {
      "Node stash shard 0 replica 0": {
        "status": "PASSED",
        "message": "Status 200"
      }
    }
  },
  "system": {
    "status": "PASSED"
  },
  "stores": {
    "status": "PASSED",
    "message": "",
    "details": {
      "Node index shard 0 replica 0": {
        "status": "PASSED",
        "message": "Status 200"
      }
    }
  },
  "overall": {
    "status": "PASSED"
  },
  "id": {
    "status": "PASSED"
  },
  "lake": {
    "status": "PASSED"
  },
  "db": {
    "status": "PASSED"
  },
  "users": {
    "status": "PASSED"
  }
}

Rights

An example response when a user does not have sufficient rights:

{
  "message": "User test does not have requested right in set admin",
  "status": 403
}

Users must have one of the rights listed in the service description in order to use the service. Rights are case-sensitive strings. The list below details all MinusOneDB managed environment rights.

admin: user can manage users, assign rights, and perform typical operational tasks (backup, restore, health checks, etc).

schema: user can edit and view the environment schema.

get: user can query data the data lake or data stores.

publish: user can publish data to the data lake.

sessionQuery: user can query all session stores.

sessionUpdate: user can add, update, or delete data from all session stores.

You can use /user/update to update the rights of a user. The collection of rights is extensible for application-specific uses.