Databases

Create a database

string

required

Database name shown in Pxxl.

string

required

postgres, mysql, mariadb, mongodb, redis, dragonfly, keydb, or clickhouse.

string

Short note about the database purpose.

string

Project connected to the database.

boolean

default:"false"

Enables supported daily backups.

string

Team that owns the database.

Node.js
Go
Python
Rust

const result = await pxxl.databases.create({
  name: "app-db",
  type: "postgres",
  projectId: "proj_123",
  dailyBackupsEnabled: true,
});

result, err := client.CreateDatabase(ctx, map[string]any{
  "name": "app-db", "type": "postgres", "projectId": "proj_123",
  "dailyBackupsEnabled": true,
})

result = client.create_database({
    "name": "app-db", "type": "postgres",
    "projectId": "proj_123", "dailyBackupsEnabled": True,
})

let result = client.create_database(json!({
    "name": "app-db", "type": "postgres",
    "projectId": "proj_123", "dailyBackupsEnabled": true
})).await?;

Returns

{
  "success": true,
  "database": {
    "id": "db_123",
    "name": "app-db",
    "type": "postgres",
    "status": "provisioning",
    "projectId": "proj_123",
    "proxyHost": null,
    "proxyPort": null,
    "createdAt": "2026-08-17T08:00:00Z"
  }
}

Database operations

Operation	Node.js	Parameters	Returns
List	`databases.list(teamId?)`	`teamId?`	`{ databases, total, success? }`
Get	`databases.get(id, teamId?)`	Database ID, `teamId?`	`{ database, success? }`
Create	`databases.create(input)`	Fields above	`{ database, success? }`
Update	`databases.update(id, input)`	`name?`, `description?`, `teamId?`	`{ database, success? }`
Delete	`databases.delete(id, teamId?)`	Database ID, `teamId?`	Action result
Start	`databases.start(id, teamId?)`	Database ID, `teamId?`	Action result
Stop	`databases.stop(id, teamId?)`	Database ID, `teamId?`	Action result
Restart	`databases.restart(id, teamId?)`	Database ID, `teamId?`	Action result
Stats	`databases.stats(id, teamId?)`	Database ID, `teamId?`	Runtime status and resource summary
Metrics	`databases.metrics(id, teamId?)`	Database ID, `teamId?`	Time-series CPU and memory metrics
Usage	`databases.usage(id, teamId?)`	Database ID, `teamId?`	Storage, network, and plan usage
Tables	`databases.tables(id, teamId?)`	Database ID, `teamId?`	Table or collection metadata
Credential	`databases.credential(id, field, teamId?)`	`field` such as `password` or `url`	Revealed credential result

Runtime responses

Start, stop, and restart calls return the accepted action and current state.

{
  "success": true,
  "message": "Database start requested",
  "databaseId": "db_123",
  "status": "starting"
}

Metrics and usage calls return structured values that can gain new metrics over time.

{
  "databaseId": "db_123",
  "status": "running",
  "cpu": { "current": 0.12, "unit": "vCPU" },
  "memory": { "currentBytes": 268435456 },
  "storage": { "usedBytes": 104857600, "limitBytes": 10737418240 },
  "series": []
}

Reveal a credential

const result = await pxxl.databases.credential("db_123", "password");
const password = result.value;

{
  "field": "password",
  "value": "sensitive-value"
}

Credential responses contain sensitive data. Do not log, cache, or send them to a browser.

SDK

CLI

API

Create a database

Database operations

Runtime responses

Reveal a credential

​Create a database

​Database operations

​Runtime responses

​Reveal a credential

Create a database

Database operations

Runtime responses

Reveal a credential