System Configuration

Each system parameter is described in detail below; a GET of /system/parameter will let you see the current value of parameter while a POST to the same path will let you change parameter's value. System parameters are extensible for application-specific usecases.

/system

Return all environment system parameters or set multiple system parameters at once.

GET/system

Base URLAuthorization Token

publish-permissive

geo

cors

token-expire-ms

curl

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

curl https://test-m1.minusonedb.com/system/ \
-d 'publish-permissive=true&geo=true&cors=["minusonedb.com"]&token-expire-ms=86400000' \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system

m1 test-m1 system -publish-permissive true -geo true -cors '["minusonedb.com"] -token-expire-ms 86400000

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

▶200 OKReturns all system parameters

{
  "init": "true",
  "cors": "minusonedb.com",
  "token-expire-ms": "720000000",
  "publish-permissive": "false",
  "property-partial": "_m1.partial",
  "password-min-length": "8",
  "property-session-id": "session.id",
  "geo": "false",
  "property-received": "_m1.receivedUTC",
  "bucket": "m1-dbd016368bb03434b4210674d451950a",
  "property-ip": "_m1.ip",
  "region": "us-east-1"
}

/system/init

Return true if the environment is initialized and false otherwise. Setting this parameter outside of /init is not supported at this time.

GET/system/init

Base URLAuthorization Token

curl

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

m1 client

m1 test-m1 system/init

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

/system/bucket

Return the S3 bucket used to store environment data. This is set at /init time and should be the the bucket associated with the environment at creation time. Setting this parameter outside of /init is not supported at this time.

GET/system/bucket

Base URLAuthorization Token

curl

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

m1 client

m1 test-m1 system/bucket

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

/system/region

Return the AWS region used for this environment's infrastructure. No value other than us-east-1 is currently supported. Setting this parameter is not supported at this time.

GET/system/region

Base URLAuthorization Token

curl

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

m1 client

m1 test-m1 system/region

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

/system/password-min-length

Return or set the minimum password length for users of the environment. The default is 8.

POST/system/password-min-length

Base URLAuthorization Token

value *

curl

curl https://test-m1.minusonedb.com/system/password-min-length \
-H "m1-auth-token: $myToken"

curl https://test-m1.minusonedb.com/system/password-min-length \
-d "value=8" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/password-min-length

m1 test-m1 system/password-min-length -value 8

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	long	Yes

/system/token-expire-ms

Return or set the default token expiration time (ttl). The default is 720000000 (200 hours).

POST/system/token-expire-ms

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/token-expire-ms \
-d "value=86400000" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/token-expire-ms

m1 test-m1 system/token-expire-ms -value 86400000

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	long	Yes

/system/publish-permissive

Return or set whether rows that fail schema validation will cause entire blocks of published data to be rejected atomically. If true, rows that fail schema validation will be persisted to the extent possible; all properties that pass validation will be persisted. Rows that are partially persisted will have have their property-partial property set to true. If false, attempts to publish rows that fail schema validation will fail with an error. The default value is false.

POST/system/publish-permissive

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/publish-permissive \
-d "value=true" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/publish-permissive

m1 test-m1 system/publish-permissive -value true

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

/system/property-partial

Return or set the property used to signal when rows are only partially persisted. This is only effectively used when publish-permissive is set to true. The specified property must be available in the environment schema. The default value is _m1.partial.

POST/system/property-partial

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/property-partial \
-d "value=_m1.partial" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/property-partial

m1 test-m1 system/property-partial -value "_m1.partial"

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	String	Yes

/system/property-ip

Return or set the property name where the ip address of the request origin machine will be added to items sent to the archive layer or session store. Items that already contain a non-null value in this property will be left unchanged. Additionally, data in this property will be used for ip address based geocoding if geo is suitably configured. The specified property must be available in the environment schema. The default value of this property is _m1.ip.

POST/system/property-ip

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/property-ip \
-d "value=_m1.ip" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/property-ip

m1 test-m1 system/property-ip -value "_m1.ip"

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	String	Yes

/system/property-received

Return or set the property name where server receipt time will be added to items sent to the archive layer or session store. The specified property must be available in the environment schema. The default value of this property is _m1.receivedUTC.

POST/system/property-received

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/property-received \
-d "value=_m1.receivedUTC" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/property-received

m1 test-m1 system/property-received -value "_m1.receivedUTC"

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	String	Yes

/system/geo

Return or specify whether geo data will be appended to items sent to the archive layer or session store. Geographic data is based on ip address. The property-ip system parameter specifies where to look for the ip address in a to be archived document. The schema of an environment with geo turned on must include the set of geo properties in the environment schema (which can be mapped to alternate property names as desired).

POST/system/geo

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/geo \
-d "value=true" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/geo

m1 test-m1 system/geo -value true

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	Boolean	Yes

/system/gcs-service-account

The google service account you have set up that has access to files you wish to load via /publish and that you have configured a trust relationship with the instance role of your environment. This is only necessary if you are using /publish to load data from a gcs bucket.

POST/system/gcs-service-account

Base URLAuthorization Token

value *

curl

curl https://test-m1.minusonedb.com/system/gcs-service-account \
-H "m1-auth-token: $myToken"

curl https://test-m1.minusonedb.com/system/gcs-service-account \
-d "value=$yourServiceAccount" -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/gcs-service-account

m1 test-m1 system -gcs-service-account $yourServiceAccount

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	String	Yes

The service account must have the roles/storage.objectViewer role for files you wish to load via /publish into your environment.

/system/cors

Return or set the list of domains that will be accepted for CORS requests; MinusOneDB environment will accept requests from all specifies domains and their subdomains. Use /system/cors/add and /system/cors/remove to add or remove individual domains.

POST/system/cors

Base URLAuthorization Token

value *

curl

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

curl https://test-m1.minusonedb.com/system/cors \
-d 'value=["minusonedb.com","yourdomain.com"]' -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/cors

m1 test-m1 system/cors -value '["minusonedb.com","yourdomain.com"]'

• rights: admin
• verbs: GET or POST

Parameter	Type	Required
value	Array	Yes

/system/cors/add

Add CORS domains.

POST/system/cors/add

Base URLAuthorization Token

domains *

curl

curl https://test-m1.minusonedb.com/system/cors/add \
-d 'domains=["domain1.com","domain2.com"]' -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/cors/add -domains '["domain1.com","domain2.com"]'

• rights: admin
• verbs: POST

Parameter	Type	Required
domains	Array	Yes

/system/cors/remove

Remove CORS domains.

POST/system/cors/remove

Base URLAuthorization Token

domains *

curl

curl https://test-m1.minusonedb.com/system/cors/remove \
-d 'domains=["domain1.com","domain2.com"]' -H "m1-auth-token: $myToken"

m1 client

m1 test-m1 system/cors/remove -domains '["domain1.com","domain2.com"]'

• rights: admin
• verbs: POST

Parameter	Type	Required
domains	Array	Yes