For the complete documentation index, see llms.txt. This page is also available as Markdown.

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
api-tokenstringRequired
Responses
200

Presets loaded successfully

application/json
objectOptional
get/database/presets
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"
          }
        }
      }
    ]
  }
}

Regenerate random name suggestions

get

Regenerates suggestedDisplayName / suggestedDbName / suggestedUser without reloading the full presets catalog. Does not return a password.

Authorizations
api-tokenstringRequired
Query parameters
typestringOptional

Engine (postgres, mysql, mariadb, mongodb, redis, valkey, clickhouse)

Responses
200

Suggestions generated

application/json
objectOptional
get/database/presets/random-names
GET /v2/database/presets/random-names HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*
{
  "status": "ok",
  "data": {
    "suggestedDisplayName": "Nova base Orion",
    "suggestedDbName": "orion-nova",
    "suggestedUser": "orion"
  }
}

List databases

get

Lists databases owned by the user plus databases linked to projects of teams the user belongs to. Secrets (vars / varsEncrypted) are omitted.

Authorizations
api-tokenstringRequired
Responses
200

Databases listed successfully

application/json
objectOptional
get/database
GET /v2/database HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*
{
  "status": "ok",
  "data": [
    {
      "_id": "1714500000365db",
      "userID": "123456789012345678",
      "displayName": "My Postgres staging",
      "projectID": null,
      "db": {
        "type": "postgres",
        "version": "17",
        "port": 5432
      },
      "clusterName": "BOLT",
      "totalRam": 512,
      "hostname": "pedro042",
      "addedAtTimestamp": 1714500000000
    }
  ]
}

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
api-tokenstringRequired
Body
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
post/database
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Database status loaded

application/json
objectOptional
get/database/{dbID}
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Database deleted

application/json
objectOptional
delete/database/{dbID}
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Body
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
patch/database/{dbID}
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Started (or already running with status error)

application/json
objectOptional
put/database/{dbID}/start
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Stopped (or already stopped with status error)

application/json
objectOptional
put/database/{dbID}/stop
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Restarted successfully

application/json
objectOptional
put/database/{dbID}/restart
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Body
gzipbooleanOptionalDefault: true
Responses
200

Backup created

application/json
objectOptional
post/database/{dbID}/backup
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
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
get/database/{dbID}/backups
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
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
get/database/{dbID}/backups/{backupId}/download
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Source database ID (backup owner)

Body
backupIdstringRequired
totalRaminteger · min: 100Required
displayNamestringOptional
projectIDstringOptional
varsEncryptedstringOptional

Mutually exclusive with vars

autoRestartbooleanOptional
Responses
200

Restore started

application/json
objectOptional
post/database/{dbID}/restore
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Logs loaded

application/json
objectOptional
get/database/{dbID}/logs
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
api-tokenstringRequired
Path parameters
dbIDstringRequired

Database ID

Responses
200

Logs deleted

application/json
objectOptional
delete/database/{dbID}/logs
DELETE /v2/database/{dbID}/logs HTTP/1.1
Host: api.discloud.app
api-token: YOUR_API_KEY
Accept: */*
{
  "status": "ok"
}

Last updated