Skip to content
BookendBookend Docs

Run the database preflight

POST
/v1/setup/database/check
curl --request POST \
  --url http://localhost:8080/v1/setup/database/check

Step 3. Checks database connectivity, dialect and the applied schema scripts and returns the result; the step is marked complete only when the check passes. Administrators only.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
ok
required
boolean
dialect
required
string
schemaScripts
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
readMs
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
writeMs
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
detail
required
string
Examplegenerated
{
  "ok": true,
  "dialect": "example",
  "schemaScripts": 1,
  "readMs": 1,
  "writeMs": 1,
  "detail": "example"
}