# Virtus Cloud

## Docs

- [Virtus Cloud API Key Authentication — Getting Started](https://docs.virtuscloud.app/api-reference/authentication.md): Generate a Virtus Cloud API key and send it in the Authorization header to authenticate every REST API request you make to the platform.
- [Push File Updates to a Deployed Application — Commit](https://docs.virtuscloud.app/api-reference/endpoint/apps/commit.md): Push updated files to a deployed Virtus Cloud application using a ZIP archive or a single file, triggering a live hot-reload of the application.
- [Permanently Delete a Virtus Cloud Application by ID](https://docs.virtuscloud.app/api-reference/endpoint/apps/delete.md): Permanently remove a Virtus Cloud application and all of its deployed files, configuration, and resource allocations. This action cannot be undone.
- [GET /v2/apps/{app_id}/deployments/current — Current Deploy](https://docs.virtuscloud.app/api-reference/endpoint/apps/deploy/info.md): Retrieve the webhook URL for the currently active deployment of your application, which you can use to trigger new deployments via Git providers.
- [GET /v2/apps/{app_id}/deployments — List Deployments](https://docs.virtuscloud.app/api-reference/endpoint/apps/deploy/list.md): Retrieve up to the last 10 deployments for an application within the past 24 hours, including each deployment's state progression and timestamps.
- [Set GitHub Webhook — POST /v2/apps/{app_id}/deploy/webhook](https://docs.virtuscloud.app/api-reference/endpoint/apps/deploy/webhooks.md): Connect your GitHub repository to Virtus Cloud using a personal access token to enable automatic deployments triggered by Git push events.
- [POST /v2/apps/{appId}/envs — Add or Edit Variables](https://docs.virtuscloud.app/api-reference/endpoint/apps/envs/add_n_edit.md): Add new environment variables or update existing ones for an application without affecting variables that are not included in the request body.
- [List Environment Variables — GET /v2/apps/{appId}/envs](https://docs.virtuscloud.app/api-reference/endpoint/apps/envs/get.md): Retrieve all environment variables set for an application. Returns every key-value pair currently defined, as a flat object in the response.
- [PUT /v2/apps/{appId}/envs — Overwrite All Variables](https://docs.virtuscloud.app/api-reference/endpoint/apps/envs/overwrite.md): Replace every environment variable on an application in one call. All previously set variables are removed and replaced with the new set you provide.
- [DELETE /v2/apps/{appId}/envs — Remove Env Variables](https://docs.virtuscloud.app/api-reference/endpoint/apps/envs/remove.md): Delete one or more environment variables from an application by supplying an array of key names. All other variables are preserved unchanged.
- [Read File Contents — GET /v2/apps/{app_id}/files/content](https://docs.virtuscloud.app/api-reference/endpoint/apps/filemanager/content.md): Retrieve the raw byte content of a specific file inside your application's filesystem, returned as a Buffer with an array of byte values.
- [Permanently Delete File — DELETE /v2/apps/{app_id}/files](https://docs.virtuscloud.app/api-reference/endpoint/apps/filemanager/delete.md): Permanently remove a file from your application's filesystem by providing its path relative to the application root. This action cannot be undone.
- [List Application Files — GET /v2/apps/{app_id}/files](https://docs.virtuscloud.app/api-reference/endpoint/apps/filemanager/list.md): List all files and directories at a given path inside your application's filesystem, including name, size, type, and last-modified timestamp.
- [Move or Rename a File — PATCH /v2/apps/{app_id}/files](https://docs.virtuscloud.app/api-reference/endpoint/apps/filemanager/patch.md): Move or rename a file within your application's filesystem by specifying its current path and the destination path you want it relocated to.
- [Create or Replace a File — PUT /v2/apps/{app_id}/files](https://docs.virtuscloud.app/api-reference/endpoint/apps/filemanager/put.md): Create a new file or replace an existing file in your application's filesystem by specifying a destination path and the file's text content.
- [Retrieve Application Configuration Details — Virtus Cloud](https://docs.virtuscloud.app/api-reference/endpoint/apps/info.md): Retrieve the technical configuration of a Virtus Cloud application — including its cluster, RAM allocation, language, and custom domain.
- [GET /v2/apps/{app_id}/logs — Fetch Application Logs](https://docs.virtuscloud.app/api-reference/endpoint/apps/logs.md): Retrieve the most recent console output from a running Virtus Cloud application. This endpoint is rate-limited to one request every 5 seconds.
- [GET /v2/apps/{app_id}/network/analytics — Traffic Stats](https://docs.virtuscloud.app/api-reference/endpoint/apps/network/analytics.md): Retrieve aggregated traffic analytics for your application, including visits, requests, bandwidth, and breakdowns by country, device, browser, and OS.
- [POST /v2/apps/{app_id}/network/custom — Custom Domain](https://docs.virtuscloud.app/api-reference/endpoint/apps/network/custom.md): Attach a custom domain to your Virtus Cloud application. After calling this endpoint, configure the returned DNS records at your domain registrar.
- [GET /v2/apps/{app_id}/network/dns — DNS Settings](https://docs.virtuscloud.app/api-reference/endpoint/apps/network/dns.md): Retrieve the DNS records required to point your custom domain to your Virtus Cloud application, including record type, name, value, and validation status.
- [POST /v2/apps/{app_id}/network/purge_cache — Purge CDN](https://docs.virtuscloud.app/api-reference/endpoint/apps/network/purge_cache.md): Immediately invalidate cached responses for one or more paths on your application's CDN edge, forcing the next request to each path to fetch fresh content.
- [POST /v2/apps/{app_id}/restart — Restart Application](https://docs.virtuscloud.app/api-reference/endpoint/apps/restart.md): Gracefully stop and immediately restart a running Virtus Cloud application to apply environment changes or recover from an unresponsive state.
- [GET /v2/apps/{app_id}/snapshots — List Snapshots](https://docs.virtuscloud.app/api-reference/endpoint/apps/snapshots/get.md): Retrieve a list of all available snapshots for your application, including file size, modification date, and a pre-signed download key for each snapshot.
- [POST /v2/apps/{app_id}/snapshots — Create Snapshot](https://docs.virtuscloud.app/api-reference/endpoint/apps/snapshots/post.md): Trigger an on-demand snapshot of your application's current state and receive a pre-signed download URL to retrieve the resulting archive immediately.
- [Send a Start Command to a Virtus Cloud Application](https://docs.virtuscloud.app/api-reference/endpoint/apps/start.md): Send a start command to a stopped Virtus Cloud application to bring it back online without redeploying or modifying any deployed files.
- [Retrieve Live Runtime Metrics for a Specific Application](https://docs.virtuscloud.app/api-reference/endpoint/apps/status.md): Retrieve real-time CPU usage, RAM consumption, network throughput, storage, and uptime metrics for a specific Virtus Cloud application.
- [Retrieve Live Status for All Your Applications at Once](https://docs.virtuscloud.app/api-reference/endpoint/apps/status-all.md): Retrieve real-time CPU usage, RAM consumption, and running state for all applications in your account or a specific workspace in one request.
- [Send a Stop Command to Shut Down a Running Application](https://docs.virtuscloud.app/api-reference/endpoint/apps/stop.md): Gracefully shut down a running Virtus Cloud application, freeing its allocated resources without deleting any deployed files or configuration.
- [Create and Deploy a New Application on Virtus Cloud](https://docs.virtuscloud.app/api-reference/endpoint/apps/upload.md): Deploy a brand-new application to Virtus Cloud by uploading a ZIP archive. The API provisions the app and returns its ID, runtime, and resource allocation.
- [POST /v2/databases — Create a Managed Database](https://docs.virtuscloud.app/api-reference/endpoint/databases/create.md): Provision a new managed MongoDB or Redis database instance on Virtus Cloud with your chosen memory allocation and version.
- [GET /v2/databases/{databaseId}/credentials/certificate — TLS Cert](https://docs.virtuscloud.app/api-reference/endpoint/databases/credentials/get_certificate.md): Retrieve the Base64-encoded TLS certificate for a Virtus Cloud database to establish encrypted connections from your application.
- [POST /v2/databases/{databaseId}/credentials/reset — Reset Password](https://docs.virtuscloud.app/api-reference/endpoint/databases/credentials/reset.md): Reset a Virtus Cloud database password or TLS certificate. Returns the new password immediately when resetting password credentials.
- [DELETE /v2/databases/{databaseId} — Delete Database](https://docs.virtuscloud.app/api-reference/endpoint/databases/delete.md): Permanently delete a Virtus Cloud managed database and all its associated data. This action is irreversible and cannot be undone.
- [PATCH /v2/databases/{databaseId} — Edit Database Settings](https://docs.virtuscloud.app/api-reference/endpoint/databases/edit.md): Update the name or memory allocation of an existing Virtus Cloud managed database without recreating or losing any data.
- [GET /v2/databases/{databaseId}/metrics — Database Metrics](https://docs.virtuscloud.app/api-reference/endpoint/databases/metrics.md): Fetch time-series performance metrics for a Virtus Cloud database, including CPU, RAM, and network usage recorded at 5-minute intervals.
- [POST /v2/databases/{databaseId}/snapshots — Create Snapshot](https://docs.virtuscloud.app/api-reference/endpoint/databases/snapshots/do_snapshot.md): Trigger an on-demand snapshot of a Virtus Cloud managed database and receive a pre-signed download URL to retrieve the backup file.
- [GET /v2/databases/{databaseId}/snapshots — List Snapshots](https://docs.virtuscloud.app/api-reference/endpoint/databases/snapshots/get.md): List all available snapshots for a Virtus Cloud managed database, including size, modification date, and download keys for each backup.
- [POST /v2/databases/{databaseId}/snapshots/restore — Restore](https://docs.virtuscloud.app/api-reference/endpoint/databases/snapshots/restore.md): Restore a Virtus Cloud managed database to a previous state by supplying the database ID and a specific snapshot version ID.
- [POST /v2/database/{databaseId}/start — Start Database](https://docs.virtuscloud.app/api-reference/endpoint/databases/start.md): Start a stopped Virtus Cloud managed database instance by its ID, making it available to accept connections again.
- [GET /v2/databases/{databaseId}/status — Database Status](https://docs.virtuscloud.app/api-reference/endpoint/databases/status.md): Retrieve the real-time operational status of a single Virtus Cloud database, including CPU, RAM, storage, network I/O, and uptime.
- [GET /v2/databases/status — All Database Statuses](https://docs.virtuscloud.app/api-reference/endpoint/databases/status-all.md): Retrieve a summarized status snapshot for every managed database in your Virtus Cloud account, including running state, CPU, and RAM.
- [POST /v2/database/{databaseId}/stop — Stop Database](https://docs.virtuscloud.app/api-reference/endpoint/databases/stop.md): Gracefully shut down a running Virtus Cloud managed database instance, freeing resources while preserving all stored data.
- [GET /v2/service/status — Platform Health Status](https://docs.virtuscloud.app/api-reference/endpoint/service/status.md): Check the current operational health of the Virtus Cloud platform, returning an overall status string and a human-readable message.
- [GET /v2/users/me — Get Current User Info](https://docs.virtuscloud.app/api-reference/endpoint/users/me.md): Retrieve your Virtus Cloud account profile, active subscription plan, memory usage, and a list of all applications associated with your account.
- [GET /v2/users/snapshots — List User Snapshots](https://docs.virtuscloud.app/api-reference/endpoint/users/snapshots.md): List all snapshots across your Virtus Cloud account for either applications or databases, including size, modification date, and download keys.
- [POST /v2/workspaces/applications — Add App to Workspace](https://docs.virtuscloud.app/api-reference/endpoint/workspace/apps/add.md): Link an existing Virtus Cloud application to a workspace, granting workspace members access to it according to their permission group.
- [DELETE /v2/workspaces/applications — Remove App from Workspace](https://docs.virtuscloud.app/api-reference/endpoint/workspace/apps/remove.md): Unlink an application from a Virtus Cloud workspace, revoking workspace member access to it without deleting the application itself.
- [POST /v2/workspaces — Create a New Workspace](https://docs.virtuscloud.app/api-reference/endpoint/workspace/create.md): Create a new collaborative workspace in your Virtus Cloud account to organize applications and share access with team members.
- [DELETE /v2/workspaces — Delete Workspace](https://docs.virtuscloud.app/api-reference/endpoint/workspace/delete.md): Permanently delete a Virtus Cloud workspace, removing all its member associations and application links. Only the workspace owner can do this.
- [GET /v2/workspaces/{workspaceId} — Get Workspace](https://docs.virtuscloud.app/api-reference/endpoint/workspace/get.md): Retrieve detailed information about a specific Virtus Cloud workspace, including its members, their permissions, and linked applications.
- [DELETE /v2/workspaces/leave — Leave Workspace](https://docs.virtuscloud.app/api-reference/endpoint/workspace/leave.md): Leave a Virtus Cloud workspace you are a member of, immediately revoking your own access to its applications and resources.
- [GET /v2/workspaces — List All Workspaces](https://docs.virtuscloud.app/api-reference/endpoint/workspace/list.md): Retrieve a list of all Virtus Cloud workspaces you belong to, including their members, linked applications, and creation timestamps.
- [GET /v2/workspaces/members/code — Invite Code](https://docs.virtuscloud.app/api-reference/endpoint/workspace/members/code.md): Retrieve your personal Virtus Cloud invite code to share with workspace owners so they can add you to their workspaces.
- [POST /v2/workspaces/members — Invite Member](https://docs.virtuscloud.app/api-reference/endpoint/workspace/members/invite.md): Add a new member to a Virtus Cloud workspace using their personal invite code and assign them a permission group for application access.
- [DELETE /v2/workspaces/members — Remove Member](https://docs.virtuscloud.app/api-reference/endpoint/workspace/members/kick.md): Remove a member from a Virtus Cloud workspace, immediately revoking their access to all workspace applications and resources.
- [PATCH /v2/workspaces/members — Update Permissions](https://docs.virtuscloud.app/api-reference/endpoint/workspace/members/perms.md): Update a workspace member's permission group on Virtus Cloud to change what they can do with the workspace's linked applications.
- [Virtus Cloud API Rate Limits and Regional Restrictions](https://docs.virtuscloud.app/api-reference/limitations-and-restrictions.md): Understand Virtus Cloud API rate limits per plan, daily request caps, blocked countries, and captcha-required regions before you start building.
- [Deploy C# and .NET Applications on Virtus Cloud Platform](https://docs.virtuscloud.app/articles/getting-started-with-csharp.md): Learn how to prepare and deploy C# and .NET applications on Virtus Cloud, including required files, project structure, .NET version, and upload steps.
- [Deploy and Host Elixir Applications on Virtus Cloud](https://docs.virtuscloud.app/articles/getting-started-with-elixir.md): Learn how to prepare and deploy Elixir applications on Virtus Cloud, including required files, Mix setup, version details, and upload steps.
- [Deploy and Host Go Applications on Virtus Cloud Today](https://docs.virtuscloud.app/articles/getting-started-with-go.md): Learn how to prepare and deploy Go applications on Virtus Cloud, including required files, module management, Go version details, and upload steps.
- [Deploy and Host Java Applications on Virtus Cloud Today](https://docs.virtuscloud.app/articles/getting-started-with-java.md): Learn how to prepare and deploy Java applications on Virtus Cloud, including required files, JAR packaging, JDK versions, and upload steps.
- [Deploy and Host Node.js Applications on Virtus Cloud](https://docs.virtuscloud.app/articles/getting-started-with-nodejs.md): Learn how to prepare and deploy JavaScript and TypeScript Node.js applications on Virtus Cloud, including required files, exclusions, and upload steps.
- [Deploy and Host PHP Applications on Virtus Cloud Today](https://docs.virtuscloud.app/articles/getting-started-with-php.md): Learn how to prepare and deploy PHP applications on Virtus Cloud, including required files, Composer support, PHP version details, and upload steps.
- [Deploy and Host Python Applications on Virtus Cloud](https://docs.virtuscloud.app/articles/getting-started-with-python.md): Learn how to prepare and deploy Python applications on Virtus Cloud, including required files, exclusions, dependency management, and upload steps.
- [Deploy and Host Rust Applications on Virtus Cloud Today](https://docs.virtuscloud.app/articles/getting-started-with-rust.md): Learn how to prepare and deploy Rust applications on Virtus Cloud, including required files, Cargo setup, version details, and upload steps.
- [Authenticate with the Virtus Cloud Blob API](https://docs.virtuscloud.app/blob-reference/authentication.md): Learn how to generate a Virtus Cloud API key and pass it in the Authorization header to authenticate with the Blob API.
- [DELETE /v1/objects/{object_id} — Delete Blob Object](https://docs.virtuscloud.app/blob-reference/endpoint/delete.md): Permanently delete a stored object from your Virtus Cloud Blob account by passing its full object ID in the request body.
- [GET /v1/objects — List Your Blob Objects](https://docs.virtuscloud.app/blob-reference/endpoint/list.md): Retrieve a paginated list of all objects stored in your Virtus Cloud Blob account, with optional prefix filtering and continuation tokens.
- [POST /v1/objects — Upload a Blob Object](https://docs.virtuscloud.app/blob-reference/endpoint/post.md): Upload a file to Virtus Cloud Blob storage using multipart/form-data and receive a CDN-hosted URL, unique ID, and file metadata in response.
- [GET /v1/account/stats — Blob Storage Statistics](https://docs.virtuscloud.app/blob-reference/endpoint/stats.md): Retrieve real-time storage usage, plan limits, and billing estimates for your Virtus Cloud Blob account in a single API call.
- [Authenticate the Virtus Cloud CLI with Your API Key](https://docs.virtuscloud.app/cli-reference/authentication.md): Connect the Virtus Cloud CLI to your account by generating an API key in the dashboard and running the auth login command.
- [Virtus Cloud CLI Command Reference](https://docs.virtuscloud.app/cli-reference/commands.md): A complete reference for every Virtus Cloud CLI command, including syntax, flags, and example output for primary and app-level commands.
- [Install the Virtus Cloud CLI on Any Platform](https://docs.virtuscloud.app/cli-reference/installation.md): Install the Virtus Cloud CLI on macOS, Linux, WSL, or Windows in minutes and start managing your applications from the terminal.
- [Virtus Cloud Brand: Logo Origins and Official Domains](https://docs.virtuscloud.app/company/brand.md): Explore the origin and meaning of the Virtus Cloud logo, the symbolism behind its design, and the official domains and online properties of the platform.
- [Virtus Cloud Legal Information: EULA and Privacy Policy](https://docs.virtuscloud.app/company/legal.md): Review Virtus Cloud's End-User License Agreement and Privacy Policy — governing your use of the platform and outlining how your data is handled.
- [Contact Virtus Cloud Support: All Available Channels](https://docs.virtuscloud.app/company/support.md): Reach the Virtus Cloud support team via the SAC dashboard, WhatsApp, Telegram, Discord, or email — find the right channel for your question.
- [Files Automatically Removed During Virtus Cloud Deployment](https://docs.virtuscloud.app/faqs/automatic-deletion-files-when-deploying-an-application-to-virtuscloud.md): Discover which files and directories Virtus Cloud removes automatically during deployment and why excluding them keeps your deploys fast and clean.
- [How to Debug Your Application on Virtus Cloud Platform](https://docs.virtuscloud.app/faqs/debugging-an-application.md): Learn how to enable detailed debug logging in discord.js and discord.py applications hosted on Virtus Cloud to diagnose runtime errors faster.
- [Fixing ABUSE_REQUESTS API Rate Limit Errors on Virtus Cloud](https://docs.virtuscloud.app/faqs/troubleshooting/ABUSE_REQUESTS.md): Resolve ABUSE_REQUESTS shutdowns on Virtus Cloud by reducing excessive Discord or Amino API calls through optimized code and effective caching.
- [Fixing better-sqlite3 Build Errors on Virtus Cloud](https://docs.virtuscloud.app/faqs/troubleshooting/BETTER_SQLITE3_ERROR.md): Resolve the 'Could not locate the bindings file' error for better-sqlite3 and quick.db by updating to a version that supports Node.js LTS v22.
- [Fixing INVALID_DEPENDENCY Errors at Application Startup](https://docs.virtuscloud.app/faqs/troubleshooting/INVALID_DEPENDENCY.md): Resolve INVALID_DEPENDENCY errors on Virtus Cloud by ensuring your package.json or requirements.txt exists in the project root with the correct filename.
- [Fixing LACK_OF_CPU Performance Issues on Virtus Cloud](https://docs.virtuscloud.app/faqs/troubleshooting/LACK_OF_CPU.md): Resolve LACK_OF_CPU shutdowns on Virtus Cloud by optimizing your code's compute usage or upgrading to a higher plan with greater CPU allocation.
- [Fixing LACK_OF_RAM Application Crashes on Virtus Cloud](https://docs.virtuscloud.app/faqs/troubleshooting/LACK_OF_RAM.md): Resolve LACK_OF_RAM shutdowns on Virtus Cloud by increasing your application's MEMORY config value or upgrading to a higher plan with more RAM.
- [Fixing MODULE_NOT_FOUND Errors on Virtus Cloud Apps](https://docs.virtuscloud.app/faqs/troubleshooting/MODULE_NOT_FOUND.md): Resolve MODULE_NOT_FOUND and ModuleNotFoundError crashes by correctly declaring missing packages in package.json or requirements.txt before deploying.
- [Fixing TOKEN_INVALID Discord Bot Authentication Errors](https://docs.virtuscloud.app/faqs/troubleshooting/TOKEN_INVALID.md): Resolve TOKEN_INVALID and LoginFailure errors in Discord bots hosted on Virtus Cloud by regenerating and correctly applying your bot token.
- [Troubleshooting Website and API Access on Virtus Cloud](https://docs.virtuscloud.app/faqs/troubleshooting/access-website.md): Diagnose and fix Unauthorized and Timeout errors when accessing a website or API hosted on Virtus Cloud — covering subdomains, ports, and host binding.
- [Fixing Lavalink Closed Abnormally Errors on Virtus Cloud](https://docs.virtuscloud.app/faqs/troubleshooting/lavalink-closed-abnormally.md): Resolve WebSocket closed abnormally (code 1006) and 400 errors when connecting a Lavalink server to your Virtus Cloud application.
- [Whitelisting Virtus Cloud Dynamic IPs in MongoDB Atlas](https://docs.virtuscloud.app/faqs/troubleshooting/whitelist-mongodb.md): Fix MongoNetworkError failures by whitelisting 0.0.0.0/0 in MongoDB Atlas — required because Virtus Cloud assigns a new dynamic IP on every restart.
- [Auto Restart: Keep Your Virtus Cloud Application Running](https://docs.virtuscloud.app/faqs/using-autorestart-in-your-virtuscloud-application.md): Learn how to enable Virtus Cloud's Auto Restart feature to automatically recover your application after unexpected crashes or failures.
- [virtuscloud.app Config File: Complete Parameter Reference](https://docs.virtuscloud.app/getting-started/config-file.md): Full reference for the virtuscloud.app config file — all parameters, runtime versions, character limits, and example configs for bots and websites.
- [Virtus Cloud: An Overview of the Managed Hosting Platform](https://docs.virtuscloud.app/getting-started/overview.md): Virtus Cloud is a managed hosting platform that lets you deploy bots, websites, APIs, and databases in minutes with zero infrastructure management.
- [Virtus Cloud Quick Start: Deploy Your First Application](https://docs.virtuscloud.app/getting-started/quick-start.md): Go from zero to a running application on Virtus Cloud in minutes — create your account, configure your app, and deploy via CLI or dashboard.
- [Virtus Cloud Platform Limits and Service Restrictions](https://docs.virtuscloud.app/platform/limitations-and-restrictions.md): Understand Virtus Cloud's resource limits — minimum RAM, CPU allocation logic, network speeds, storage caps, and service enforcement policies.
- [Virtus Cloud Platform: Applications, Databases & Storage](https://docs.virtuscloud.app/platform/overview.md): Explore Virtus Cloud's managed hosting platform — application hosting, databases, blob storage, and secure infrastructure built on Hivelocity hardware.
- [Virtus Cloud SDKs: JavaScript and Python Clients](https://docs.virtuscloud.app/sdks/introduction.md): Use the official Virtus Cloud SDKs for JavaScript and Python to integrate Blob storage and platform APIs into your application with minimal boilerplate.