Developers

Everything the dashboard does, the API does

Provisioning belongs in your pipeline, not in a browser tab. Authenticate with a scoped bearer key and drive the full lifecycle programmatically.

Create a database

Request

curl -X POST https://cloudbase.webyne.com/api/v1/databases \
  -H "Authorization: Bearer $WEBYNEDB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production-db",
    "project": "ERP System",
    "engine": "POSTGRESQL",
    "plan": "db-pro",
    "region": "noida-1",
    "allowed_ips": ["203.0.113.4/32"]
  }'

Response

{
  "id": "cmt8ig79s0003obcjxvd7z0tg",
  "name": "production-db",
  "status": "PENDING",
  "engine": "POSTGRESQL",
  "engine_version": "17",
  "connection": {
    "host": "cloudbase.webyne.com",
    "port": 15000,
    "database": "production_db",
    "username": "wdb_production_db",
    "password": "…",
    "tls": "Required (sslmode=require)"
  }
}

Creation returns immediately with the connection details and aPENDINGstatus. Poll the database until it reportsRUNNING, which is when the endpoint starts accepting connections — usually under a minute.

API reference

Method	Endpoint	Purpose
POST	/v1/databases	Create database
GET	/v1/databases	List databases
GET	/v1/databases/{id}	Database details
DELETE	/v1/databases/{id}	Delete database
POST	/v1/databases/{id}/resize	Resize plan or storage
POST	/v1/databases/{id}/backups	Create backup
POST	/v1/databases/{id}/restore	Restore from a backup
POST	/v1/databases/{id}/replicas	Create read replica
GET	/v1/databases/{id}/metrics	Metrics
GET	/v1/databases/{id}/logs	Logs
POST	/v1/databases/{id}/users	Database user or role
POST	/v1/databases/{id}/ai/analyse	AI analysis

Also available: firewall rules, database users, credentials, TLS enablement, start/stop/restart and query-plan explanation.

The provisioning flow

What happens between your request and a database accepting connections.

1
Create database
Name it and pick the project it belongs to.
2
Select engine
PostgreSQL, MySQL, MariaDB, Valkey or pgvector.
3
Select version
Explicit, tested engine versions.
4
Select region
Regions with an attached node accept new databases.
5
Select plan
vCPU, RAM and NVMe storage.
6
Configure HA
Single node, or replicas for read scale.
7
Configure backup
Schedule and retention window.
8
Configure network
Public endpoint with an IP allow-list.
9
Review price
Monthly cost including GST before anything is created.
10
Deploy
Provisioning runs automatically and reports progress.

Working with the API

Scoped keys

Create read-only or read-write keys from the dashboard. Keys are stored hashed and shown once, at creation. Revoking one takes effect immediately.

Safe to retry

Long-running operations are queued as jobs with idempotency keys, so a retried request after a timeout does not create a second database or a duplicate backup.

Honest errors

A request that cannot be satisfied returns a 4xx with a specific message rather than silently doing something adjacent. Unsupported parameters are rejected, not ignored.

Building an integration?

Tell us what you are automating and we will make sure the API covers it.

Talk to engineering Sign in and create a key