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

NameTypeRequired
datadb_CreateDbInstanceInputYes

data

FieldTypeRequired
subscriptionIdStringNo
nameStringYes
dbEnginedb_DbEngineYes
versionStringYes
passwordStringYes
ipWhitelistStringNo
isBackupEnabledBooleanNo
backupProductIdIDNo
backupOccurrenceStringNo
backupRetentionStringNo

Variables

{
  "data": {
    "name": "<instance name>",
    "dbEngine": "PostgreSQL",
    "version": "<engine version>",
    "password": "<password>"
  }
}

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

NameTypeRequired
datadb_UpdateDbInstanceInputYes

data

FieldTypeRequired
idIDYes
subscriptionIdStringNo
ipWhitelistStringNo
isBackupEnabledBooleanNo
backupProductIdIDNo
backupOccurrenceStringNo
backupRetentionStringNo

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

NameTypeRequired
datadb_RestoreDbInstanceInputYes

data

FieldTypeRequired
dbIdIDYes
idIDYes
subscriptionIdIDNo
dbBackupSubscriptionIdIDYes

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

NameTypeRequired
dbInstanceIdStringYes

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

NameTypeRequired
pagerdb_PagerInputNo
filterdb_FilterInputNo

filter

FieldTypeRequired
statusdb_DatabaseStatusFilterNo
subscriptionIdStringNo

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!

FieldType
documents[db_DatabaseInstanceResponse!]!
paginationdb_Pagination!