Database

List database presets

get

Returns the Dispack catalog of available engines (versions, ports, volumes), random name/password suggestions, and per-engine vars with required/optional env keys plus fromSuggestions (suggested* → env) so clients can build the POST /database body without hardcoding env names.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Responses

200

Presets loaded successfully

application/json

objectOptional

401

Authentication error

application/json

get/database/presets

HTTPcURLJavaScriptPython

GET /v2/database/presets HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "data": {
    "databases": [
      {
        "type": "postgres",
        "versions": [
          "16",
          "17"
        ],
        "extensions": [
          "pgvector"
        ],
        "defaultPort": 5432,
        "suggestedDisplayName": "Nova base Brisa",
        "suggestedDbName": "brisa-aurora",
        "suggestedUser": "brisa",
        "suggestedPassword": "a1b2c3d4e5f6",
        "vars": {
          "required": [
            "POSTGRES_DB",
            "POSTGRES_USER",
            "POSTGRES_PASSWORD"
          ],
          "optional": [],
          "fromSuggestions": {
            "POSTGRES_DB": "suggestedDbName",
            "POSTGRES_USER": "suggestedUser",
            "POSTGRES_PASSWORD": "suggestedPassword"
          }
        }
      }
    ]
  }
}

Create database

post

Starts asynchronous provisioning of a managed database. Returns HTTP 200 immediately with the new id. Poll GET /database/{dbID} until the resource exists and is online. Minimum plan Diamond (4). Optional projectID bills quota to the project owner and requires project admin access.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Body

application/json

displayNamestringRequired

Friendly name (required)

totalRaminteger · min: 100Required

RAM in MB (minimum 100)

projectIDstringOptional

Optional project to link

autoRestartbooleanOptional

Responses

200

Creation started

application/json

objectOptional

400

Invalid body (missing fields, varsEncrypted on create, invalid vars)

application/json

401

Authentication error

application/json

403

Plan or RAM quota insufficient

application/json

429

Another process is already running for this resource

application/json

503

No cluster available or hostname exhausted

application/json

post/database

HTTPcURLJavaScriptPython

POST /v2/database HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "displayName": "My Postgres staging",
  "db": {
    "type": "postgres",
    "version": "17"
  },
  "vars": {
    "POSTGRES_DB": "app_db",
    "POSTGRES_USER": "app_rw",
    "POSTGRES_PASSWORD": "secret"
  },
  "totalRam": 512
}

{
  "status": "ok",
  "id": "1714500000365db",
  "message": "The database is being created. Track progress by querying the resource."
}

Database details and status

get

Returns live container status plus plaintext vars (decrypted). Same access model as the dashboard: owner or team member with access to the linked project.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Database status loaded

application/json

objectOptional

401

Authentication error

application/json

403

No access to this database

application/json

404

Database not found

application/json

get/database/{dbID}

HTTPcURLJavaScriptPython

GET /v2/database/{dbID} HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Database status loaded.",
  "database": {
    "_id": "1714500000365db",
    "projectID": null,
    "clusterName": "BOLT",
    "hostname": "pedro042",
    "displayName": "My Postgres staging",
    "dbType": "postgresql",
    "dbEngine": "postgres",
    "dbVersion": "17",
    "extensions": [],
    "totalRam": 512,
    "owner": {
      "id": "123456789012345678",
      "username": "dev_user",
      "avatar": null
    },
    "perms": null,
    "vars": {
      "POSTGRES_DB": "app_db",
      "POSTGRES_USER": "app_rw",
      "POSTGRES_PASSWORD": "***"
    },
    "online": true,
    "exists": true,
    "totalUsedRam": 187.3,
    "last_restart": "2 minutes",
    "dataVolumeSizeHuman": "1.2G"
  }
}

Delete database

delete

Permanently removes the database record and its infrastructure. Requires delete_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Database deleted

application/json

objectOptional

401

Authentication error

application/json

403

No permission to delete

application/json

404

Database not found

application/json

429

Another process is already running

application/json

delete/database/{dbID}

HTTPcURLJavaScriptPython

DELETE /v2/database/{dbID} HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Your application has been removed."
}

Update database

patch

Updates displayName, hostname and/or totalRam. Requires commit_app; changing totalRam also requires edit_ram. Hostname requires owner plan > 3. Changing hostname or RAM triggers an async infrastructure rebuild (rebuilding=true + opId); poll GET /database/{dbID}.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Body

application/json

displayNamestringOptional

hostnamestringOptional

Private hostname (1–2 segments a-z0-9_ joined by -, max 25)

totalRaminteger · min: 100 · max: 16384Optional

Responses

200

Database updated (optionally rebuilding)

application/json

objectOptional

400

Invalid body or no fields to update

application/json

401

Authentication error

application/json

403

No permission or plan too low for hostname

application/json

404

Database not found

application/json

409

Hostname already taken

application/json

429

Another process is already running

application/json

patch/database/{dbID}

HTTPcURLJavaScriptPython

PATCH /v2/database/{dbID} HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "displayName": "Staging DB",
  "totalRam": 1024
}

{
  "status": "ok",
  "message": "Database updated successfully.",
  "rebuilding": false,
  "data": {
    "_id": "1714500000365db",
    "displayName": "Staging DB",
    "totalRam": 1024,
    "hostname": "pedro042"
  }
}

Start database

put

Starts the database container. Requires start_app. Subject to RAM/slot checks.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Started (or already running with status error)

application/json

objectOptional

401

Authentication error or start failure

application/json

403

No permission or resource limit

application/json

404

Database not found

application/json

429

Another process is already running

application/json

put/database/{dbID}/start

HTTPcURLJavaScriptPython

PUT /v2/database/{dbID}/start HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Your application has been connected."
}

Stop database

put

Stops the database container. Requires stop_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Stopped (or already stopped with status error)

application/json

objectOptional

401

Authentication error

application/json

403

No permission to stop

application/json

404

Database not found

application/json

429

Another process is already running

application/json

put/database/{dbID}/stop

HTTPcURLJavaScriptPython

PUT /v2/database/{dbID}/stop HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Your application has been turned off."
}

Restart database

put

Restarts the database container. Requires restart_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Restarted successfully

application/json

objectOptional

401

Authentication error or restart failure

application/json

403

No permission or resource limit

application/json

404

Database not found

application/json

429

Another process is already running

application/json

put/database/{dbID}/restart

HTTPcURLJavaScriptPython

PUT /v2/database/{dbID}/restart HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Your application has been restarted."
}

Create database backup

post

Creates a backup of the managed database (synchronous). Requires backup_app. Returns download metadata; S3 keys are stripped from the response.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Body

application/json

gzipbooleanOptionalDefault: true

Responses

200

Backup created

application/json

objectOptional

400

Backup not supported or failed

application/json

401

Authentication error

application/json

403

No permission to backup

application/json

404

Database not found

application/json

429

Another process is already running

application/json

503

Database offline

application/json

post/database/{dbID}/backup

HTTPcURLJavaScriptPython

POST /v2/database/{dbID}/backup HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "gzip": true
}

{
  "status": "ok",
  "data": {
    "backupId": 20240101120000,
    "downloadUrl": "https://example.s3.amazonaws.com/..."
  }
}

List database backups

get

Lists backups stored in S3 for this database. Requires status_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Query parameters

limitintegerOptional

Page size (1–1000, default 50). Alias maxKeys also accepted.

cursorstringOptional

Continuation token from a previous response

detailstring · enumOptional

minimal (default) or full

Possible values:

Responses

200

Backups listed

application/json

objectOptional

401

Authentication error

application/json

403

No permission

application/json

404

Database not found

application/json

get/database/{dbID}/backups

HTTPcURLJavaScriptPython

GET /v2/database/{dbID}/backups HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "data": {
    "backups": [
      {
        "backupId": 20240101120000,
        "createdAt": "2024-01-01T12:00:00.000Z",
        "size": 1048576
      }
    ],
    "nextCursor": null
  }
}

Get backup download URL

get

Returns a presigned URL for the backup dump. Requires backup_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

backupIdstringRequired

Backup ID

Query parameters

expiresInDaysinteger · min: 1 · max: 14Optional

URL validity in days (1–14)

Responses

200

Download URL generated

application/json

objectOptional

400

Invalid request

application/json

401

Authentication error

application/json

403

No permission

application/json

404

Database or backup not found

application/json

get/database/{dbID}/backups/{backupId}/download

HTTPcURLJavaScriptPython

GET /v2/database/{dbID}/backups/{backupId}/download HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "data": {
    "downloadUrl": "https://example.s3.amazonaws.com/...",
    "expiresAt": "2024-01-08T12:00:00.000Z"
  }
}

Restore backup as a new database

post

Creates a new managed database from an existing backup (asynchronous). Requires backup_app on the source database. Minimum plan Diamond (4). Returns the new id immediately; poll GET /database/{id}.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Source database ID (backup owner)

Body

application/json

backupIdstringRequired

totalRaminteger · min: 100Required

displayNamestringOptional

projectIDstringOptional

varsEncryptedstringOptional

Mutually exclusive with vars

autoRestartbooleanOptional

Responses

200

Restore started

application/json

objectOptional

400

Invalid body

application/json

401

Authentication error

application/json

403

No permission or plan/quota insufficient

application/json

404

Source database or project not found

application/json

429

Another process is already running

application/json

post/database/{dbID}/restore

HTTPcURLJavaScriptPython

POST /v2/database/{dbID}/restore HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "backupId": 20240101120000,
  "totalRam": 512,
  "displayName": "Restored Postgres"
}

{
  "status": "ok",
  "id": "1714500000999db",
  "message": "Restore from backup has started. Track progress by querying the resource."
}

Get database logs

get

Returns recent container logs (same shape as app logs). Requires logs_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Logs loaded

application/json

objectOptional

401

Authentication error

application/json

403

No permission to read logs

application/json

404

Database not found

application/json

get/database/{dbID}/logs

HTTPcURLJavaScriptPython

GET /v2/database/{dbID}/logs HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok",
  "message": "Your application logs have been loaded",
  "app": {
    "_id": "1714500000365db",
    "terminal": {
      "big": "...",
      "small": "...",
      "url": null
    }
  }
}

Delete database logs

delete

Purges stored logs for the database. Requires logs_app.

Authorizations

ApiKeyAuth

api-tokenstringRequired

Path parameters

dbIDstringRequired

Database ID

Responses

200

Logs deleted

application/json

objectOptional

401

Authentication error

application/json

403

No permission to delete logs

application/json

404

Database not found

application/json

delete/database/{dbID}/logs

HTTPcURLJavaScriptPython

DELETE /v2/database/{dbID}/logs HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*

{
  "status": "ok"
}