Objects
The objects the calls take and answer.
Error
| Field |
Type |
Description |
error (required) |
string |
What went wrong, in words. |
code |
string |
A stable code where there is one: unauthenticated, account_pending, consent_required, read_only_key, forbidden, rate_limited. |
hint |
string |
What to do. |
field |
string |
The field a 400 is about. |
id |
string |
On 409 of POST /v1/moves: the live move of the organization. |
state |
string |
On 409 of an action: the move's state. |
login_url |
string |
|
CreateMove
| Field |
Type |
Description |
installation |
string |
The installation; may be left out when the account has one. |
org |
integer, at least 1 |
The organization's number. Give org or tenant. |
tenant |
string |
The organization's uuid, when your tenants are uuids. |
require_approval |
boolean |
Wait for approve after the check (default from the service's settings). |
customer_can_move_back |
boolean |
Let the organization's administrator move back from the cabinet. |
callback_url |
string (uri) |
Where this move's state changes are posted (else the account's receiver). |
external_ref |
string |
Your own reference (a customer id), echoed in the move and its webhooks. |
customer_email |
string (email), up to 254 characters |
The organization's administrator's address. It gets the alerts about their side only (agent_gone, customer_db_unreachable, extension_needed), on plans with alerts; your account's own addresses get every alert. |
MoveState
token_issued → (the administrator runs the command) agent_connected → checking →
checked (or blocked by a finding) → moving → moved; moving_back → moved_back.
failed has a phase (check, move, move_back). moved_back and cancelled are final.
string: token_issued, agent_connected, checking, checked, blocked, moving, moved, moving_back, moved_back, failed, cancelled
Move
| Field |
Type |
Description |
id (required) |
string |
|
account |
string |
|
installation |
string |
|
org (required) |
integer |
|
tenant |
string |
|
external_ref |
string |
|
customer_email |
string |
As given when the move was made. |
state (required) |
MoveState |
|
phase |
string: check, move, move_back |
|
error |
string |
|
warning |
string |
|
progress |
string |
The latest line of progress. |
actions (required) |
array of string |
What POST /v1/moves/{id}/{action} allows now. |
require_approval |
boolean |
|
approved |
boolean |
|
customer_can_move_back |
boolean |
|
callback_url |
string |
|
install |
object |
Only in the answer that made the token. |
install.command |
string |
docker run -it …: the organization's administrator runs it in their network. |
install.command_noninteractive |
string |
|
install.token |
string |
lsi_…, works for 30 minutes. |
install.expires_at |
string (date-time) |
|
install_expires_at |
string (date-time) |
|
portal_url |
string |
The organization's cabinet; only in the answer that made the link. |
agent_update_command |
string |
|
database |
string |
The organization's database (after the agent connected). |
db_addr |
string |
|
pg_version |
string |
|
installer_version |
string |
|
hostname |
string |
|
relay_port |
integer |
|
agent_connected_at |
string (date-time) |
|
agent_seen_at |
string (date-time) |
|
agent_status |
object |
|
check_verdict |
string: ready, review, blocked |
|
check_exit |
integer |
|
findings |
array of Finding |
|
extensions |
array of ExtensionStatus |
|
profile |
string |
The organization's routing once moved (fdw, fdw+direct, direct). |
created_by |
object |
|
created_by.kind |
string |
|
created_by.id |
string |
|
run_started_at |
string (date-time) |
|
created_at (required) |
string (date-time) |
|
updated_at |
string (date-time) |
|
moved_at |
string (date-time) |
|
moved_back_at |
string (date-time) |
|
Finding
| Field |
Type |
Description |
severity |
string: spec_error, blocker, unsupported, change, warning, info |
|
code |
string |
|
object |
string |
|
message |
string |
|
who |
string: saas, customer |
Who has to act on it. |
ExtensionStatus
| Field |
Type |
Description |
name |
string |
|
status |
string: present, created, needs_admin, unavailable, failed |
|
version |
string |
|
cloud_version |
string |
|
error |
string |
|
MoveEvent
| Field |
Type |
Description |
seq |
integer |
|
at |
string (date-time) |
|
kind |
string: state, progress, warning, error, note |
|
state |
string |
|
msg |
string |
|
attrs |
object |
|
CheckReport
The report of lokadb check -json, schema 1: verdict, findings, tables and more.
| Field |
Type |
Description |
schema_version |
integer |
|
verdict |
string |
|
findings |
array of object |
|
Installation
| Field |
Type |
Description |
id |
string |
|
account |
string |
|
installation_key |
string |
|
database |
string |
|
runner |
string |
|
enabled |
boolean |
|
inventory |
object |
|
inventory_at |
string (date-time) |
|
status |
object |
|
status_at |
string (date-time) |
|
created_at |
string (date-time) |
|
Runner
| Field |
Type |
Description |
id |
string |
|
account |
string |
|
name |
string |
|
hostname |
string |
|
version |
string |
|
public_key |
string |
|
fingerprint |
string |
The key the installers show to the organizations' administrators. |
capabilities |
array of string |
|
installation |
string |
|
status |
string: active, standby, removed |
|
registered_at |
string (date-time) |
|
last_seen_at |
string (date-time) |
|
online |
boolean |
|
Org
| Field |
Type |
Description |
org |
integer |
|
location |
string: cloud, customer, moving, returning |
|
profile |
string |
|
move |
string |
|
state |
string |
|
tenant |
string |
|
external_ref |
string |
|
name |
string |
|
OrgCard
| Field |
Type |
Description |
org |
integer |
|
location |
string |
|
profile |
string |
|
name |
string |
|
external_ref |
string |
|
move |
Move |
|
moves |
array of object |
|
extensions |
array of ExtensionStatus |
|
findings |
array of Finding |
|
agent |
object |
|
Job
| Field |
Type |
Description |
id |
string |
|
account |
string |
|
installation |
string |
|
runner |
string |
|
move_id |
string |
|
kind |
string: inventory, org.lookup, check, enable, agent.prepare, credentials.store, move, move_back, org.release, extensions.sync |
|
v |
integer |
|
args |
object |
|
state |
string: queued, leased, done, failed, cancelled, lost |
|
attempt |
integer |
|
cancel_requested |
boolean |
|
status |
string |
|
result |
object |
|
error |
object |
|
created_at |
string (date-time) |
|
started_at |
string (date-time) |
|
finished_at |
string (date-time) |
|
JobAnswer
| Field |
Type |
Description |
job (required) |
Job |
|
result |
object |
For a check: {exit, verdict, report}. |
JobEvent
| Field |
Type |
Description |
seq |
integer |
|
at |
string (date-time) |
|
kind |
string |
|
msg |
string |
|
attrs |
object |
|
Plan
| Field |
Type |
Description |
account |
string |
|
name |
string |
|
status |
string: pending, active, suspended |
|
plan |
string: starter, growth, enterprise |
|
org_limit |
integer |
|
overage_allowed |
boolean |
|
billable |
integer |
Organizations in use now (a live move or at a customer). |
WebhookEndpoint
| Field |
Type |
Description |
url |
string or null |
|
secret |
string |
whs_…, only when made. |
events |
array of string |
|
updated_at |
string (date-time) |
|
WebhookBody
| Field |
Type |
Description |
type (required) |
string: move.state |
|
id (required) |
string |
The move. |
org (required) |
integer |
|
tenant |
string |
|
external_ref |
string |
|
state (required) |
MoveState |
|
previous |
string |
|
phase |
string |
|
error |
string |
|
at (required) |
string (date-time) |
|
AlertRule
| Field |
Type |
Description |
rule |
string |
|
enabled |
boolean |
|
threshold |
integer |
|
recipients |
array of string |
|
summary |
string |
|
event |
boolean |
|