{ "opencollection": "1.0.0", "info": { "name": "Coolify Applications Databases API", "version": "0.1" }, "items": [ { "info": { "name": "Databases", "type": "folder" }, "items": [ { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all databases." }, { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/backups", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get backups details by database UUID." }, { "info": { "name": "Create Backup", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/:uuid/backups", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new scheduled backup configuration for a database" }, { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get database by UUID." }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.coolify.io/api/v1/databases/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update database by UUID." }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.coolify.io/api/v1/databases/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." }, { "name": "delete_configurations", "value": "", "type": "query", "description": "Delete configurations." }, { "name": "delete_volumes", "value": "", "type": "query", "description": "Delete volumes." }, { "name": "docker_cleanup", "value": "", "type": "query", "description": "Run docker cleanup." }, { "name": "delete_connected_networks", "value": "", "type": "query", "description": "Delete connected networks." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete database by UUID." }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.coolify.io/api/v1/databases/:uuid/backups/:scheduled_backup_uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." }, { "name": "scheduled_backup_uuid", "value": "", "type": "path", "description": "UUID of the backup configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a specific backup configuration for a given database, identified by its UUID and the backup ID" }, { "info": { "name": "Delete backup configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.coolify.io/api/v1/databases/:uuid/backups/:scheduled_backup_uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database" }, { "name": "scheduled_backup_uuid", "value": "", "type": "path", "description": "UUID of the backup configuration to delete" }, { "name": "delete_s3", "value": "", "type": "query", "description": "Whether to delete all backup files from S3" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a backup configuration and all its executions." }, { "info": { "name": "Create (PostgreSQL)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/postgresql", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new PostgreSQL database." }, { "info": { "name": "Create (Clickhouse)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/clickhouse", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new Clickhouse database." }, { "info": { "name": "Create (DragonFly)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/dragonfly", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new DragonFly database." }, { "info": { "name": "Create (Redis)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/redis", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new Redis database." }, { "info": { "name": "Create (KeyDB)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/keydb", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new KeyDB database." }, { "info": { "name": "Create (MariaDB)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/mariadb", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new MariaDB database." }, { "info": { "name": "Create (MySQL)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/mysql", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new MySQL database." }, { "info": { "name": "Create (MongoDB)", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/mongodb", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new MongoDB database." }, { "info": { "name": "Delete backup execution", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.coolify.io/api/v1/databases/:uuid/backups/:scheduled_backup_uuid/executions/:execution_uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database" }, { "name": "scheduled_backup_uuid", "value": "", "type": "path", "description": "UUID of the backup configuration" }, { "name": "execution_uuid", "value": "", "type": "path", "description": "UUID of the backup execution to delete" }, { "name": "delete_s3", "value": "", "type": "query", "description": "Whether to delete the backup from S3" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a specific backup execution." }, { "info": { "name": "List backup executions", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/backups/:scheduled_backup_uuid/executions", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database" }, { "name": "scheduled_backup_uuid", "value": "", "type": "path", "description": "UUID of the backup configuration" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all executions for a specific backup configuration." }, { "info": { "name": "Start", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/start", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start database. `Post` request is also accepted." }, { "info": { "name": "Stop", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/stop", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." }, { "name": "docker_cleanup", "value": "", "type": "query", "description": "Perform docker cleanup (prune networks, volumes, etc.)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Stop database. `Post` request is also accepted." }, { "info": { "name": "Restart", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/restart", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Restart database. `Post` request is also accepted." }, { "info": { "name": "List Envs", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/envs", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all envs by database UUID." }, { "info": { "name": "Create Env", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/:uuid/envs", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create env by database UUID." }, { "info": { "name": "Update Env", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.coolify.io/api/v1/databases/:uuid/envs", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update env by database UUID." }, { "info": { "name": "Update Envs (Bulk)", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.coolify.io/api/v1/databases/:uuid/envs/bulk", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update multiple envs by database UUID." }, { "info": { "name": "Delete Env", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.coolify.io/api/v1/databases/:uuid/envs/:env_uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." }, { "name": "env_uuid", "value": "", "type": "path", "description": "UUID of the environment variable." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete env by UUID." }, { "info": { "name": "List Storages", "type": "http" }, "http": { "method": "GET", "url": "https://app.coolify.io/api/v1/databases/:uuid/storages", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all persistent storages and file storages by database UUID." }, { "info": { "name": "Create Storage", "type": "http" }, "http": { "method": "POST", "url": "https://app.coolify.io/api/v1/databases/:uuid/storages", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a persistent storage or file storage for a database." }, { "info": { "name": "Update Storage", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.coolify.io/api/v1/databases/:uuid/storages", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a persistent storage or file storage by database UUID." }, { "info": { "name": "Delete Storage", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.coolify.io/api/v1/databases/:uuid/storages/:storage_uuid", "params": [ { "name": "uuid", "value": "", "type": "path", "description": "UUID of the database." }, { "name": "storage_uuid", "value": "", "type": "path", "description": "UUID of the storage." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a persistent storage or file storage by database UUID." } ] } ], "bundled": true }