# Shard Cloud

- [Welcome to Shard Cloud](https://docs.shardcloud.app/index.md): Shard Cloud is a platform that provides user-friendly, reliable cloud hosting for your apps, bots, databases, and VMs. Get started in minutes.
- [Getting Started](https://docs.shardcloud.app/quickstart.md): Get your projects live in minutes with Shard Cloud. This guide walks you through deploying your apps and databases on our platform with ease.
- [Database Services](https://docs.shardcloud.app/databases.md): ShardCloud provides fully managed database services with high availability and built-in security.
- [Applications](https://docs.shardcloud.app/apps.md): ShardCloud provides a comprehensive hosting platform designed for modern web applications. Our infrastructure supports various deployment scenarios with enterprise-grade features accessible to developers of all levels.
- [VPS Services](https://docs.shardcloud.app/vps.md): ShardCloud provides fully managed Virtual Private Servers with SSH access, automated backups, and real-time monitoring.
- [Domains](https://docs.shardcloud.app/domains.md): Buy a domain through Shard Cloud, or bring one you already own and point it at your apps and VMs.
- [Custom Docker Images](https://docs.shardcloud.app/custom-docker-images.md): Deploy apps from your own Dockerfile instead of Shard Cloud's auto-detected language containers.
- [How to create your .shardcloud config file](https://docs.shardcloud.app/config.md): Learn how to create your ShardCloud configuration file
- [Node.js Hosting Guide](https://docs.shardcloud.app/languages/javascript.md): Learn how to deploy Node.js applications on ShardCloud platform.
- [Python Hosting Guide](https://docs.shardcloud.app/languages/python.md): Learn how to deploy Python applications on ShardCloud platform.
- [Go Hosting Guide](https://docs.shardcloud.app/languages/go.md): Learn how to deploy Go applications on ShardCloud platform.
- [C# Hosting Guide](https://docs.shardcloud.app/languages/csharp.md): Learn how to deploy C# (.NET) applications on ShardCloud platform.
- [Ruby Hosting Guide](https://docs.shardcloud.app/languages/ruby.md): Learn how to deploy Ruby applications on ShardCloud platform.
- [Elixir Hosting Guide](https://docs.shardcloud.app/languages/elixir.md): Learn how to deploy Elixir applications on ShardCloud platform.
- [Static HTML Hosting Guide](https://docs.shardcloud.app/languages/static.md): Learn how to deploy static HTML websites on ShardCloud platform.
- [PHP Hosting Guide](https://docs.shardcloud.app/languages/php.md): Learn how to deploy PHP applications on ShardCloud platform.
- [Java Hosting Guide](https://docs.shardcloud.app/languages/java.md): Learn how to deploy Java applications on ShardCloud platform.
- [How Shard Cloud platform works](https://docs.shardcloud.app/shardcloud-overview.md)
- [Info, Limits and Restrictions of shard cloud](https://docs.shardcloud.app/limits.md): On this page, you will find more details and the limits of our platform.
- [Welcome to Shard Cloud Tutorials](https://docs.shardcloud.app/tutorials/introduction.md): Explore comprehensive tutorials for deploying your applications on Shard Cloud. From web frameworks to bots, we've got you covered.
- [How to Use GitHub Actions for CI/CD](https://docs.shardcloud.app/tutorials/platform/github-actions.md): Deploy your application to Shard Cloud directly from your GitHub workflows.
- [How to Set Up Your Custom Domain](https://docs.shardcloud.app/tutorials/platform/custom-domain.md): Learn how to configure a custom domain for your Shard Cloud application.
- [How to Set Up Git Integration](https://docs.shardcloud.app/tutorials/platform/git-integration.md): Configure automatic deployments from GitHub to Shard Cloud.
- [How to Host a Lavalink Server](https://docs.shardcloud.app/tutorials/platform/lavalink.md): Learn how to create and host your own Lavalink music server on Shard Cloud.
- [How to Host Puppeteer Applications](https://docs.shardcloud.app/tutorials/platform/puppeteer.md): Learn how to run Puppeteer browser automation scripts on Shard Cloud.
- [How to Host Selenium Applications](https://docs.shardcloud.app/tutorials/platform/selenium.md): Learn how to run Selenium browser automation scripts on Shard Cloud.
- [How to Host Discord Bots](https://docs.shardcloud.app/tutorials/bots/discord.md): Learn how to create and host Discord bots on Shard Cloud with Node.js and Python examples.
- [How to Host Telegram Bots](https://docs.shardcloud.app/tutorials/bots/telegram.md): Learn how to create and host Telegram bots on Shard Cloud with Node.js and Python examples.
- [How to Host WhatsApp Bots](https://docs.shardcloud.app/tutorials/bots/whatsapp.md): Learn how to create and host WhatsApp bots on Shard Cloud using whatsapp-web.js.
- [How to Host Slack Bots](https://docs.shardcloud.app/tutorials/bots/slack.md): Learn how to create and host Slack bots on Shard Cloud with Node.js and Python examples.
- [How to Host X (Twitter) Bots](https://docs.shardcloud.app/tutorials/bots/x-twitter.md): Learn how to create and host X (Twitter) bots on Shard Cloud.
- [How to Host Express Applications](https://docs.shardcloud.app/tutorials/api/express.md): Learn how to create and deploy Express.js applications on Shard Cloud.
- [How to Host Fastify Applications](https://docs.shardcloud.app/tutorials/api/fastify.md): Learn how to create and deploy Fastify applications on Shard Cloud.
- [How to Host Gin Applications](https://docs.shardcloud.app/tutorials/api/gin.md): Learn how to create and deploy Gin applications on Shard Cloud.
- [How to Host Flask Applications](https://docs.shardcloud.app/tutorials/api/flask.md): Learn how to create and deploy Flask applications on Shard Cloud.
- [How to Host Django Applications](https://docs.shardcloud.app/tutorials/api/django.md): Learn how to create and deploy Django applications on Shard Cloud.
- [How to Host Next.js Applications](https://docs.shardcloud.app/tutorials/website/nextjs.md): Learn how to deploy Next.js applications on Shard Cloud.
- [How to Host React Applications](https://docs.shardcloud.app/tutorials/website/react.md): Learn how to deploy React applications on Shard Cloud.
- [How to Host Vue Applications](https://docs.shardcloud.app/tutorials/website/vue.md): Learn how to deploy Vue.js applications on Shard Cloud.
- [How to Host Nuxt Applications](https://docs.shardcloud.app/tutorials/website/nuxt.md): Learn how to deploy Nuxt applications on Shard Cloud.
- [How to Host Vite Applications](https://docs.shardcloud.app/tutorials/website/vite.md): Learn how to deploy Vite applications on Shard Cloud.
- [How to Host Angular Applications](https://docs.shardcloud.app/tutorials/website/angular.md): Learn how to deploy Angular applications on Shard Cloud.
- [How to Host Astro Applications](https://docs.shardcloud.app/tutorials/website/astro.md): Learn how to deploy Astro applications on Shard Cloud.
- [How to Host Remix Applications](https://docs.shardcloud.app/tutorials/website/remix.md): Learn how to deploy Remix applications on Shard Cloud.
- [How to Host Phoenix Applications](https://docs.shardcloud.app/tutorials/website/phoenix.md): Learn how to deploy Elixir Phoenix applications on Shard Cloud.
- [How to Host Ruby on Rails Applications](https://docs.shardcloud.app/tutorials/website/rails.md): Learn how to deploy Ruby on Rails applications on Shard Cloud.
- [Shard Cloud CLI](https://docs.shardcloud.app/cli/cli.md): This package provides a direct way to interact with the official ShardCloud API.
- [Authentication](https://docs.shardcloud.app/cli/auth.md): Learn how to authenticate with the Shard Cloud CLI.
- [Commands](https://docs.shardcloud.app/cli/commands.md): List of all commands available
- [Shard Cloud VS Code Extension](https://docs.shardcloud.app/vscode/vscode.md): Manage your ShardCloud applications and databases directly from VS Code.
- [.shardignore File](https://docs.shardcloud.app/vscode/shardignore.md): Control which files are excluded from deployment with the .shardignore file.
- [Commands & Settings](https://docs.shardcloud.app/vscode/commands.md): All available commands and configuration settings for the ShardCloud VS Code extension.
- [Shard Cloud CDN](https://docs.shardcloud.app/cdn/introduction.md): Upload your files and let us handle the rest — edge caching, image compression, and global delivery out of the box.
- [Authorization](https://docs.shardcloud.app/cdn/authorization.md): Before getting started, you'll need to generate an API token. This can be done by accessing the dashboard, then navigating to Config > Integrations.
- [Supported File Types](https://docs.shardcloud.app/cdn/supported-file-types.md): Full list of MIME types accepted by the Shard Cloud CDN.
- [List CDN files](https://docs.shardcloud.app/cdn/cdn/list-cdn-files.md): Lists CDN files for the authenticated user. Supports cursor-based pagination (50 items per page) and optional search filtering by filename.
- [Upload a CDN file](https://docs.shardcloud.app/cdn/cdn/upload-a-cdn-file.md): Uploads a file to the CDN. Requires a valid subscription. File must be between 6KB and 100MB. An optional folder, mime_type, and expire_at can be provided.
- [Delete a CDN file](https://docs.shardcloud.app/cdn/cdn/delete-a-cdn-file.md): Deletes a file from the CDN. The fileName query parameter is validated for ownership via middleware before the handler executes.
- [Get a single CDN file](https://docs.shardcloud.app/cdn/cdn/get-a-single-cdn-file.md): Retrieves metadata for a specific CDN file. The fileName query parameter is validated for ownership via middleware before the handler executes.
- [Get CDN usage stats](https://docs.shardcloud.app/cdn/cdn/get-cdn-usage-stats.md): Returns CDN storage statistics for the authenticated user (limit, usage, file count).
- [Purge a CDN folder cache](https://docs.shardcloud.app/cdn/cdn/purge-a-cdn-folder-cache.md): Purges all cached files in a folder (or all files if folder is omitted) for the authenticated user.
- [Welcome](https://docs.shardcloud.app/api-reference/introduction.md): Before getting started, you'll need to generate an API token. This can be done by accessing the dashboard, then navigating to Config> Integrations.
- [List your databases](https://docs.shardcloud.app/api-reference/databases/list-your-databases.md)
- [Create a database](https://docs.shardcloud.app/api-reference/databases/create-a-database.md)
- [Get database details](https://docs.shardcloud.app/api-reference/databases/get-database-details.md)
- [Delete a database](https://docs.shardcloud.app/api-reference/databases/delete-a-database.md): Owner-only (workspace members with lesser roles cannot delete).
- [Get database replica status](https://docs.shardcloud.app/api-reference/databases/get-database-replica-status.md)
- [Get database resource metrics](https://docs.shardcloud.app/api-reference/databases/get-database-resource-metrics.md)
- [Restart a stopped database](https://docs.shardcloud.app/api-reference/databases/restart-a-stopped-database.md)
- [Stop a database](https://docs.shardcloud.app/api-reference/databases/stop-a-database.md)
- [Change database password](https://docs.shardcloud.app/api-reference/databases/change-database-password.md)
- [Get database connection URL](https://docs.shardcloud.app/api-reference/databases/get-database-connection-url.md)
- [Update database RAM/vCPU](https://docs.shardcloud.app/api-reference/databases/update-database-ramvcpu.md)
- [Enable the database's visualizer UI](https://docs.shardcloud.app/api-reference/databases/enable-the-databases-visualizer-ui.md): One-way — there is no endpoint to disable it once enabled. Adds RAM overhead (+512 MB) to the database's resource plan.
- [List your apps](https://docs.shardcloud.app/api-reference/apps/list-your-apps.md)
- [Create an app from an uploaded project](https://docs.shardcloud.app/api-reference/apps/create-an-app-from-an-uploaded-project.md)
- [Create an app from a Custom Docker Image](https://docs.shardcloud.app/api-reference/apps/create-an-app-from-a-custom-docker-image.md): JSON counterpart of POST /apps for apps deployed straight from an already-built Custom Docker Image — no file upload. The image's own ENTRYPOINT/CMD runs; language/version/entrypoint/custom_command don't apply.
- [List available language/runtime versions](https://docs.shardcloud.app/api-reference/apps/list-available-languageruntime-versions.md)
- [Get app details](https://docs.shardcloud.app/api-reference/apps/get-app-details.md)
- [Delete an app](https://docs.shardcloud.app/api-reference/apps/delete-an-app.md): Owner-only (workspace members with lesser roles cannot delete).
- [List app deployments](https://docs.shardcloud.app/api-reference/apps/list-app-deployments.md)
- [Redeploy a previous deployment](https://docs.shardcloud.app/api-reference/apps/redeploy-a-previous-deployment.md): Rebuilds and redeploys the app from a past deploy's source snapshot.
- [Get app run status](https://docs.shardcloud.app/api-reference/apps/get-app-run-status.md)
- [Run, stop, or restart the app](https://docs.shardcloud.app/api-reference/apps/run-stop-or-restart-the-app.md)
- [Get app resource metrics](https://docs.shardcloud.app/api-reference/apps/get-app-resource-metrics.md)
- [Get HTTP traffic dashboard data](https://docs.shardcloud.app/api-reference/apps/get-http-traffic-dashboard-data.md): Requires the app to have analytics enabled (PATCH /apps/{app_id}/analytics).
- [Get raw HTTP request logs](https://docs.shardcloud.app/api-reference/apps/get-raw-http-request-logs.md)
- [Stream app logs](https://docs.shardcloud.app/api-reference/apps/stream-app-logs.md): Server-Sent Events stream of live container logs. At most 2 concurrent streams per app — a 3rd blocks until one frees up. Heartbeat comment every 5s.
- [Update app config and resources](https://docs.shardcloud.app/api-reference/apps/update-app-config-and-resources.md)
- [Change the app's language runtime version](https://docs.shardcloud.app/api-reference/apps/change-the-apps-language-runtime-version.md)
- [Enable public web access](https://docs.shardcloud.app/api-reference/apps/enable-public-web-access.md): Promotes the app to a public web app (requires 512 MB min RAM) and assigns it a subdomain.
- [Disable public web access](https://docs.shardcloud.app/api-reference/apps/disable-public-web-access.md)
- [Redeploy app code](https://docs.shardcloud.app/api-reference/apps/redeploy-app-code.md): Uploads a new project ZIP and redeploys the app in place (equivalent to a git push deploy).
- [Get a file's raw content](https://docs.shardcloud.app/api-reference/apps/get-a-files-raw-content.md)
- [List a directory](https://docs.shardcloud.app/api-reference/apps/list-a-directory.md)
- [Create or overwrite a file](https://docs.shardcloud.app/api-reference/apps/create-or-overwrite-a-file.md)
- [Delete file(s) or a directory](https://docs.shardcloud.app/api-reference/apps/delete-files-or-a-directory.md)
- [Move or rename file(s)](https://docs.shardcloud.app/api-reference/apps/move-or-rename-files.md): Body can be a single MoveFileRequest object or an array of them to move several files in one call.
- [Search file contents](https://docs.shardcloud.app/api-reference/apps/search-file-contents.md)
- [Search file names](https://docs.shardcloud.app/api-reference/apps/search-file-names.md)
- [Attach a custom domain](https://docs.shardcloud.app/api-reference/apps/attach-a-custom-domain.md): Domain must already be pointed at the platform (CNAME to the platform's edge).
- [Remove a custom domain](https://docs.shardcloud.app/api-reference/apps/remove-a-custom-domain.md)
- [Run a shell command in the app's container](https://docs.shardcloud.app/api-reference/apps/run-a-shell-command-in-the-apps-container.md): Server-Sent Events stream of command output. Heartbeat comment every 10s.
- [Set a custom error page](https://docs.shardcloud.app/api-reference/apps/set-a-custom-error-page.md): Served (from the CDN) whenever the app is stopped or unreachable.
- [Remove the custom error page](https://docs.shardcloud.app/api-reference/apps/remove-the-custom-error-page.md)
- [Get environment variables](https://docs.shardcloud.app/api-reference/apps/get-environment-variables.md)
- [Replace environment variables](https://docs.shardcloud.app/api-reference/apps/replace-environment-variables.md): Owner-only. Replaces the full env var set — not a partial merge.
- [List your VMs](https://docs.shardcloud.app/api-reference/vms/list-your-vms.md)
- [Create a VM](https://docs.shardcloud.app/api-reference/vms/create-a-vm.md): Either template or (distro + ram) must be provided — a template supplies its own ram and distro.
- [List available Linux distros](https://docs.shardcloud.app/api-reference/vms/list-available-linux-distros.md)
- [Get VM details](https://docs.shardcloud.app/api-reference/vms/get-vm-details.md)
- [Delete a VM](https://docs.shardcloud.app/api-reference/vms/delete-a-vm.md)
- [Update VM RAM](https://docs.shardcloud.app/api-reference/vms/update-vm-ram.md)
- [Change the VM's root password](https://docs.shardcloud.app/api-reference/vms/change-the-vms-root-password.md)
- [Start the VM](https://docs.shardcloud.app/api-reference/vms/start-the-vm.md)
- [Stop the VM](https://docs.shardcloud.app/api-reference/vms/stop-the-vm.md)
- [Run shell commands inside the VM](https://docs.shardcloud.app/api-reference/vms/run-shell-commands-inside-the-vm.md): Server-Sent Events stream of command output, one or more commands run in order (up to 50 per request). Heartbeat comment every 10s.
- [Reinstall the VM's OS](https://docs.shardcloud.app/api-reference/vms/reinstall-the-vms-os.md): Wipes the VM's disk and reinstalls its distro from scratch with a new root password.
- [Get VM resource metrics](https://docs.shardcloud.app/api-reference/vms/get-vm-resource-metrics.md)
- [List your Custom Docker Images](https://docs.shardcloud.app/api-reference/custom-images/list-your-custom-docker-images.md)
- [Build a Custom Docker Image](https://docs.shardcloud.app/api-reference/custom-images/build-a-custom-docker-image.md): Uploads a build context (a ZIP with a Dockerfile at its root) and builds it into a registry-hosted image. Poll GET /custom-images/{image_id} or stream GET /custom-images/{image_id}/logs to watch the build.
- [Get a Custom Docker Image](https://docs.shardcloud.app/api-reference/custom-images/get-a-custom-docker-image.md)
- [Rebuild a Custom Docker Image](https://docs.shardcloud.app/api-reference/custom-images/rebuild-a-custom-docker-image.md): Uploads a new build context and rebuilds the image in place; apps deployed from it keep the same image ID.
- [Delete a Custom Docker Image](https://docs.shardcloud.app/api-reference/custom-images/delete-a-custom-docker-image.md)
- [Stream a Custom Docker Image's build logs](https://docs.shardcloud.app/api-reference/custom-images/stream-a-custom-docker-images-build-logs.md): Server-Sent Events stream — replays build history so far, then streams live lines while a build is running, or the last completed build's log if nothing is currently building. At most 2 concurrent streams per image. Heartbeat comment every 5s.
- [List resource alerts for a project](https://docs.shardcloud.app/api-reference/project/list-resource-alerts-for-a-project.md): Works for any project type (App, Database, or VM) — :project_id is that resource's id.
- [Create a resource alert](https://docs.shardcloud.app/api-reference/project/create-a-resource-alert.md): Fires (an email/Discord notification) when the metric stays over threshold for alert_minutes minutes straight.
- [Delete a resource alert](https://docs.shardcloud.app/api-reference/project/delete-a-resource-alert.md)
- [List a project's backups](https://docs.shardcloud.app/api-reference/project/list-a-projects-backups.md)
- [Create an on-demand backup](https://docs.shardcloud.app/api-reference/project/create-an-on-demand-backup.md): For a Database project, target_database (the logical database to back up) is required in the body. Omit the body entirely for App/VM projects.
- [Delete a backup](https://docs.shardcloud.app/api-reference/project/delete-a-backup.md): Backups can only be deleted after a minimum retention age — deleting too early returns 403.
- [Get a signed download URL for a backup](https://docs.shardcloud.app/api-reference/project/get-a-signed-download-url-for-a-backup.md)
- [Restore a backup](https://docs.shardcloud.app/api-reference/project/restore-a-backup.md): For a Database project, target_database is required in the body. This drops and replaces the current data — destructive.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)
- [openapi](/cdn/openapi.json)