Instances
All requests go to the gateway.
Authentication is not yet
documented. Placeholder values in angle brackets (<...>) are yours to fill in.
Create Instance
Mutation · db_createDbInstance
Creates a database instance.
Arguments
| Name | Type | Required |
|---|---|---|
data | db_CreateDbInstanceInput | Yes |
data
| Field | Type | Required |
|---|---|---|
subscriptionId | String | No |
name | String | Yes |
dbEngine | db_DbEngine | Yes |
version | String | Yes |
password | String | Yes |
ipWhitelist | String | No |
isBackupEnabled | Boolean | No |
backupProductId | ID | No |
backupOccurrence | String | No |
backupRetention | String | No |
The schema doesn't list accepted values for version, backupOccurrence or
backupRetention. They're plain strings, not enums.
Variables
{
"data": {
"name": "<instance name>",
"dbEngine": "PostgreSQL",
"version": "<engine version>",
"password": "<password>"
}
}
Never commit a real database password to source control.
Request
mutation CreateDbInstance($data: db_CreateDbInstanceInput!) {
db_createDbInstance(data: $data) {
id
name
engine
version
type
status
}
}
Response
db_DatabaseInstanceResponse,
nullable.
Update Instance
Mutation · db_updateDbInstance
Updates a database instance. The input only has fields for the IP whitelist and backup settings. It has none for the name, engine, version or password.
Arguments
| Name | Type | Required |
|---|---|---|
data | db_UpdateDbInstanceInput | Yes |
data
| Field | Type | Required |
|---|---|---|
id | ID | Yes |
subscriptionId | String | No |
ipWhitelist | String | No |
isBackupEnabled | Boolean | No |
backupProductId | ID | No |
backupOccurrence | String | No |
backupRetention | String | No |
Variables
{
"data": {
"id": "<instance id>",
"isBackupEnabled": true
}
}
Request
mutation UpdateDbInstance($data: db_UpdateDbInstanceInput!) {
db_updateDbInstance(data: $data) {
status
message
}
}
Response
db_ModifyDbInstanceResponse,
nullable.
Restore Instance
Mutation · db_restoreDbInstance
Restores a database instance.
Arguments
| Name | Type | Required |
|---|---|---|
data | db_RestoreDbInstanceInput | Yes |
data
| Field | Type | Required |
|---|---|---|
dbId | ID | Yes |
id | ID | Yes |
subscriptionId | ID | No |
dbBackupSubscriptionId | ID | Yes |
The input has both dbId and id, and the schema doesn't say what id
refers to. Next to dbId it's probably the backup to restore from (see
backup history), but that isn't
confirmed. Note also that subscriptionId is an ID here, but a String in
the create and update inputs.
Variables
{
"data": {
"dbId": "<instance id>",
"id": "<id>",
"dbBackupSubscriptionId": "<backup subscription id>"
}
}
Request
mutation RestoreDbInstance($data: db_RestoreDbInstanceInput!) {
db_restoreDbInstance(data: $data) {
status
message
}
}
Response
db_ModifyDbInstanceResponse,
nullable.
Get Instance
Query · db_getUserDbInstanceById
Returns one database instance by its id.
Arguments
| Name | Type | Required |
|---|---|---|
dbInstanceId | String | Yes |
Variables
{
"dbInstanceId": "<instance id>"
}
Request
query GetDbInstance($dbInstanceId: String!) {
db_getUserDbInstanceById(dbInstanceId: $dbInstanceId) {
id
name
engine
version
type
status
host
connection
adminToolUrl
publicPort
ipWhitelist
isBackupEnabled
backup {
status
occurrence_display_name
retention_display_name
}
createdAt
updatedAt
}
}
Response
db_DatabaseInstanceResponse,
nullable. The schema doesn't say when the result is null.
List Instances
Query · db_listDbInstancesByUser
Lists your database instances, page by page.
Arguments
| Name | Type | Required |
|---|---|---|
pager | db_PagerInput | No |
filter | db_FilterInput | No |
filter
| Field | Type | Required |
|---|---|---|
status | db_DatabaseStatusFilter | No |
subscriptionId | String | No |
Variables
{
"pager": { "page": 1, "limit": 20 },
"filter": { "status": "Running" }
}
Request
query ListDbInstances($pager: db_PagerInput, $filter: db_FilterInput) {
db_listDbInstancesByUser(pager: $pager, filter: $filter) {
documents {
id
name
engine
version
status
createdAt
}
pagination {
currentPage
lastPage
total
}
}
}
Response
db_ListUserDbInstancesResponse!
| Field | Type |
|---|---|
documents | [db_DatabaseInstanceResponse!]! |
pagination | db_Pagination! |