Installations¶
Your databases as your runner reports them, and what is moved out of them.
List installations¶
GET /v1/accounts/{a}/installations
Your databases, one per SaaS database a runner serves.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
a (required) |
path | string | Your account's id (the panel's URL, or account in a move). |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The installations. | object |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |
An installation and its runner¶
GET /v1/installations/{i}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
i (required) |
path | string |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The installation. | object |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |
Organizations at customers and with a live move¶
GET /v1/installations/{i}/orgs
Parameters
| Name | In | Type | Description |
|---|---|---|---|
i (required) |
path | string | |
location |
query | string: cloud, customer, moving, returning, billable |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The organizations and their counts. | object |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |
One organization¶
GET /v1/installations/{i}/orgs/{org}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
i (required) |
path | string | |
org (required) |
path | integer, at least 1 |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The organization, its live move and its moves. | OrgCard |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |
Name an organization¶
PATCH /v1/installations/{i}/orgs/{org}
Your name and reference for the organization (shown in the panel).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
i (required) |
path | string | |
org (required) |
path | integer, at least 1 |
Body (application/json)
| Field | Type | Description |
|---|---|---|
name |
string, up to 200 characters | |
external_ref |
string, up to 200 characters |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The organization. | OrgCard |
400 |
BadRequest: A field is missing or wrong. | Error |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |
The extensions your tables need, per organization at a customer¶
GET /v1/installations/{i}/extensions
Look here before you deploy a migration that adds an extension.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
i (required) |
path | string |
Responses
| Status | Description | Body |
|---|---|---|
200 |
Per extension, the organizations that have it and those that do not. | array of object |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |
The latest check of your database¶
GET /v1/installations/{i}/report
Parameters
| Name | In | Type | Description |
|---|---|---|---|
i (required) |
path | string |
Responses
| Status | Description | Body |
|---|---|---|
200 |
The report of lokadb check -json. |
CheckReport |
401 |
Unauthorized: No valid API key (or session). login_url is for the panel. |
Error |
429 |
TooMany: rate_limited: over the key's or the address's rate (see Rate limits); wait Retry-After seconds. |
Error |
404 |
NotFound: No such object in your account (another account's ids answer the same). | Error |