# Square Cloud

> Square Cloud docs: deploy Discord bots, websites, APIs and databases, store files with Blob Storage, and automate it all with the CLI, SDKs and REST API.

## Docs

- [Docs: Host Discord Bots, Websites, APIs and Databases](https://docs.squarecloud.app/en/getting-started/overview.md): Square Cloud docs: deploy Discord bots, websites, APIs and managed databases in minutes, with guides for Node.js, Python and more, plus CLI and API references.
- [Quickstart: Deploy Your First App](https://docs.squarecloud.app/en/getting-started/quick-start.md): Put your first app online on Square Cloud in minutes: write a small web server, add the configuration file, zip it and deploy from the dashboard or the CLI.
- [squarecloud.app Configuration File Reference](https://docs.squarecloud.app/en/getting-started/config-file.md): Configure your app with the squarecloud.app file: MAIN, MEMORY, VERSION, DISPLAY_NAME, RUNTIME, START, SUBDOMAIN and AUTORESTART, with bot and site examples.
- [Environment Variables and Secrets](https://docs.squarecloud.app/en/platform/environment-variables.md): Store tokens, API keys and connection strings as environment variables on Square Cloud from the dashboard, the CLI or the API, and read them in your code.
- [squarecloud.ignore: Exclude Files from Your Deploy](https://docs.squarecloud.app/en/getting-started/squarecloud-ignore.md): Use squarecloud.ignore to leave files out of CLI and VS Code deploys: .gitignore syntax, default exclusions like node_modules, pattern rules and examples.
- [Bot Hosting 24/7: Discord, WhatsApp and Telegram Bots](https://docs.squarecloud.app/en/services/bots.md): Host a Discord, WhatsApp or Telegram bot 24/7 on Square Cloud: isolated containers, auto-restart, real-time logs and deploys from the dashboard, CLI or GitHub.
- [Website and API Hosting: Node.js, Python, Static Sites](https://docs.squarecloud.app/en/services/sites.md): Website and API hosting behind Cloudflare: included squareweb.app subdomain, auto-renewing TLS, global CDN, WAF and custom domains on Standard and up.
- [Managed Databases: PostgreSQL, MySQL, MongoDB, Redis](https://docs.squarecloud.app/en/services/databases.md): Managed PostgreSQL, MySQL, MongoDB and Redis databases: TLS-only connections, NVMe storage, one-click snapshots and no bandwidth fees, from the Standard plan.
- [Blob Storage: S3-Compatible Object Storage with CDN](https://docs.squarecloud.app/en/services/blob.md): S3-compatible object storage with a global CDN, private files, temporary and share links, and no transfer fees. Included in every Square Cloud plan.
- [Troubleshooting: Fix Common Square Cloud Errors](https://docs.squarecloud.app/en/platform/troubleshooting.md): Fix common Square Cloud errors: upload rejections, sites that don't load, EADDRINUSE, missing modules, Discord bot login failures and database SSL errors.
- [App Won't Start: Deploy, Site and Boot Errors](https://docs.squarecloud.app/en/platform/troubleshooting/app-wont-start.md): Fix a Square Cloud app that won't deploy, start or load: upload errors, timeouts on port 80, EADDRINUSE, Cannot find module, INVALID_DEPENDENCY and UTC times.
- [Discord Bot Errors: Invalid Token, Intents, Lavalink](https://docs.squarecloud.app/en/platform/troubleshooting/discord-bot-errors.md): Fix Discord bot errors on Square Cloud: LoginFailure and TokenInvalid, disallowed intents, Message Content Intent, Lavalink code 1006 and bots going offline.
- [Database Connection Errors: SSL, MySQL, MongoDB](https://docs.squarecloud.app/en/platform/troubleshooting/database-connection-errors.md): Fix database connection errors on Square Cloud: MySQL Host is not allowed, MongoNetworkError, Atlas IP whitelist, timeouts, ECONNREFUSED and SSL/TLS issues.
- [Supported Languages and Runtimes](https://docs.squarecloud.app/en/runtimes/introduction.md): Check the languages and versions Square Cloud supports, how RUNTIME or MAIN selects the runtime, how dependencies install and what each runtime image includes.
- [Host a Node.js App, API or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-nodejs.md): Deploy Node.js and TypeScript apps, APIs and Discord bots on Square Cloud: set MAIN and START, install dependencies from package.json and go live in minutes.
- [Deploy a Bun App or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-bun.md): Run Bun apps and bots on Square Cloud: add bun to package.json, start it with npx bun in START, and deploy on the Node.js runtime with automatic npm install.
- [Deploy a Deno App or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-deno.md): Run Deno apps and bots on Square Cloud: add deno to package.json, start it with npx deno in START and the permissions you need, on the Node.js runtime.
- [How to Create a package.json for Node.js](https://docs.squarecloud.app/en/articles/how-to-create-your-package-json.md): Create a package.json for a Node.js app: initialize it with npm init, add start scripts and dependencies, and see what Square Cloud installs in production.
- [Host a Python App, API or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-python.md): Deploy Python apps, APIs and Discord bots on Square Cloud: set MAIN, install dependencies from requirements.txt or pyproject.toml, and go live in minutes.
- [How to Create a requirements.txt File](https://docs.squarecloud.app/en/articles/how-to-create-your-requirements.md): Create a requirements.txt for a Python app: generate it with pip freeze inside a virtual environment, pin versions with ==, and deploy it on Square Cloud.
- [How to Create a pyproject.toml File](https://docs.squarecloud.app/en/articles/how-to-create-your-pyproject.md): Create a pyproject.toml for a Python app: declare project metadata, pinned dependencies and a build system so Square Cloud can install it with pip.
- [Host a Static HTML/CSS Website](https://docs.squarecloud.app/en/articles/getting-started-with-html.md): Host a static HTML, CSS and JavaScript website on Square Cloud: upload index.html with your assets, add a 404.html or vite.html fallback, and publish it.
- [Host a Java App or Bot (JAR)](https://docs.squarecloud.app/en/articles/getting-started-with-java.md): Deploy a Java app or Discord bot on Square Cloud: build an executable JAR, set MAIN to the .jar file, and Square Cloud starts it with java -jar on JDK 25.
- [Deploy a Rust App, API or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-rust.md): Deploy Rust apps, APIs and bots on Square Cloud: upload your Cargo project with Cargo.toml, set MAIN to src/main.rs, and it builds with cargo run --release.
- [Host a Ruby App or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-ruby.md): Host Ruby apps and bots on Square Cloud: include a Gemfile, set MAIN to your entry file, and Square Cloud runs bundle install and starts it with ruby MAIN.
- [Deploy an Elixir App, API or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-elixir.md): Deploy an Elixir app, API or bot on Square Cloud: include mix.exs, and Square Cloud fetches dependencies with mix deps.get and starts it with mix run --no-halt.
- [Host a PHP Website or API](https://docs.squarecloud.app/en/articles/getting-started-with-php.md): Host a PHP website or API on Square Cloud: set MAIN to index.php, let Square Cloud install your Composer packages, and serve with the built-in server or Swoole.
- [Deploy a Go App, API or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-go.md): Deploy Go apps, APIs and bots on Square Cloud: include go.mod and go.sum, set MAIN to main.go, and use START=go run . when package main spans several files.
- [Host a C# / .NET App or Bot](https://docs.squarecloud.app/en/articles/getting-started-with-csharp.md): Host C# and .NET apps and bots on Square Cloud: point MAIN to your .csproj, and Square Cloud restores packages and starts it with dotnet run on .NET 10.
- [Infrastructure, Uptime and Security](https://docs.squarecloud.app/en/platform/overview.md): Square Cloud infrastructure: SOC 2 and ISO 27001 certified New York data center, 10 Gbps per server, multi-layer DDoS protection and 99.99% uptime.
- [Plans and Pricing: Hobby, Standard, Pro, Enterprise](https://docs.squarecloud.app/en/platform/plans.md): Square Cloud pricing plans and cost: Hobby, Standard, Pro and Enterprise, with the RAM, vCPU, Blob storage and features of each tier.
- [Resource Limits: RAM, CPU, Bandwidth and Storage](https://docs.squarecloud.app/en/platform/limitations-and-restrictions.md): Square Cloud resource limits: minimum RAM per project, vCPUs by RAM, dedicated bandwidth, 10 GB NVMe storage and the LACK_OF_RAM and LACK_OF_CPU statuses.
- [Changelog](https://docs.squarecloud.app/en/changelog.md): Discover the latest news and improvements in Square Cloud. Follow product releases, performance optimizations, and much more.
- [How to Host a Discord Bot 24/7](https://docs.squarecloud.app/en/tutorials/bots/discord.md): Host your Discord bot 24/7 on Square Cloud: create the token, write a discord.js or discord.py bot, deploy it and keep it online.
- [How to Host a WhatsApp Bot 24/7](https://docs.squarecloud.app/en/tutorials/bots/whatsapp.md): Host a WhatsApp bot 24/7 on Square Cloud with whatsapp-web.js or Baileys: scan the QR Code from the logs, keep the session saved and deploy.
- [How to Host a Telegram Bot 24/7](https://docs.squarecloud.app/en/tutorials/bots/telegram.md): Host your Telegram bot 24/7 on Square Cloud: get a token from BotFather, write a grammY or pyTelegramBotAPI bot, deploy it and test it.
- [How to Host a Slack Bot](https://docs.squarecloud.app/en/tutorials/bots/slack.md): Host a Slack bot on Square Cloud with Bolt for JavaScript or Python: create the tokens, run it in Socket Mode with no public URL, deploy and test it.
- [How to Build and Host an X (Twitter) Bot](https://docs.squarecloud.app/en/tutorials/bots/x.md): Build and host an X (Twitter) bot on Square Cloud with Node.js and twitter-api-v2: set up the API keys, reply to new mentions and deploy it.
- [Receive Top.gg Vote Webhooks](https://docs.squarecloud.app/en/tutorials/topgg-webhook-config.md): Top.gg vote webhooks on Square Cloud: receive vote events in Node.js or Python, verify the x-topgg-signature HMAC with your secret and send a test vote.
- [Host a Lavalink Server for Your Music Bot](https://docs.squarecloud.app/en/tutorials/how-to-create-your-lavalink-server.md): Lavalink server hosting for Discord music bots: a v4 application.yml with the YouTube plugin, port 80, a strong password and how your bot connects.
- [How to Host a Website or API](https://docs.squarecloud.app/en/tutorials/how-to-deploy-your-website.md): Host a website or API on Square Cloud: set up the squarecloud.app file with SUBDOMAIN and port 80, see static and Next.js examples and framework guides.
- [Deploy a React App (Vite Build)](https://docs.squarecloud.app/en/tutorials/website/react.md): Deploy a React app on Square Cloud: build it with Vite into dist/, then serve it with the static runtime or a small Node.js server on your subdomain.
- [Deploy a Vite App](https://docs.squarecloud.app/en/tutorials/website/vite.md): Deploy a Vite app on Square Cloud: build it with npm run build, then serve dist/ with the static runtime or a small Node.js server on your subdomain.
- [Deploy a Vue App](https://docs.squarecloud.app/en/tutorials/website/vue.md): Deploy a Vue app on Square Cloud: scaffold it with npm create vue@latest, build it into dist/, and serve it with the static runtime or a Node.js server.
- [Deploy an Angular App](https://docs.squarecloud.app/en/tutorials/website/angular.md): Deploy an Angular app on Square Cloud: build it with ng build, serve the browser folder with the static runtime or Node.js, or run the SSR server.
- [Deploy an Astro Site](https://docs.squarecloud.app/en/tutorials/website/astrojs.md): Deploy an Astro site on Square Cloud: build it into dist/ and serve it with the static runtime or Node.js, or run on-demand rendering with @astrojs/node.
- [Deploy a Gatsby Site](https://docs.squarecloud.app/en/tutorials/website/gatsby.md): Deploy a Gatsby site on Square Cloud: build it with npm run build, then serve the public/ folder with the static runtime or a small Node.js server.
- [Deploy a Preact App](https://docs.squarecloud.app/en/tutorials/website/preact.md): Deploy a Preact app on Square Cloud: create it with npm init preact, build it into dist/, and serve it with the static runtime or a Node.js server.
- [Deploy a SolidJS App](https://docs.squarecloud.app/en/tutorials/website/solidjs.md): Deploy a SolidJS app on Square Cloud: run the SolidStart server from .output/server/index.mjs, or serve a Solid and Vite build with the static runtime.
- [Next.js Hosting: Deploy a Next.js App](https://docs.squarecloud.app/en/tutorials/website/nextjs.md): Deploy a Next.js app on Square Cloud: build it with next build, run next start with a START command, zip the project with .next, and go live on HTTPS.
- [Deploy a Nuxt App (Nitro Server)](https://docs.squarecloud.app/en/tutorials/website/nuxt.md): Deploy a Nuxt app on Square Cloud: build it with npm run build, run the .output/server/index.mjs server as MAIN, or generate a static site instead.
- [Deploy React Router (formerly Remix)](https://docs.squarecloud.app/en/tutorials/website/remix.md): Deploy a React Router app (formerly Remix) on Square Cloud: build with npm run build, set START=npm run start to run react-router-serve, and go live.
- [Deploy a Qwik App](https://docs.squarecloud.app/en/tutorials/website/qwik.md): Deploy a Qwik City app on Square Cloud: add the static adapter and serve dist/ with the static runtime, or add the Express adapter and run its server.
- [Deploy a Ruby on Rails App](https://docs.squarecloud.app/en/tutorials/website/ruby-on-rails.md): Deploy a Ruby on Rails app on Square Cloud: set RAILS_MASTER_KEY, then precompile assets, prepare the database and start the server with a START command.
- [Deploy a Phoenix (Elixir) App](https://docs.squarecloud.app/en/tutorials/website/phoenix.md): Deploy a Phoenix app on Square Cloud: set SECRET_KEY_BASE and PHX_HOST, build assets and start the server in production mode with a START command.
- [Laravel Hosting: Deploy a Laravel App](https://docs.squarecloud.app/en/tutorials/api/laravel.md): Deploy a Laravel app on Square Cloud: Composer runs on its own, and a START command runs migrations and php artisan serve on port 80, plus APP_KEY and env vars.
- [Deploy an Express API](https://docs.squarecloud.app/en/tutorials/api/express.md): Deploy an Express API on Square Cloud: read the port from PORT, listen on 0.0.0.0, zip the project with package.json and squarecloud.app, and go live on HTTPS.
- [Deploy a Fastify API](https://docs.squarecloud.app/en/tutorials/api/fastify.md): Deploy a Fastify API on Square Cloud: listen on host 0.0.0.0 and the PORT variable, zip the project with package.json and squarecloud.app, and go live on HTTPS.
- [Deploy a NestJS API](https://docs.squarecloud.app/en/tutorials/api/nestjs.md): Deploy a NestJS API on Square Cloud: build dist/ locally with npm run build, set MAIN=dist/main.js, and let the generated code read the PORT variable.
- [Flask Hosting: Deploy a Flask App](https://docs.squarecloud.app/en/tutorials/api/flask.md): Deploy a Flask app on Square Cloud: list flask and gunicorn in requirements.txt, start Gunicorn on 0.0.0.0:80 with a START command, and go live on HTTPS.
- [Deploy a Django App with Gunicorn](https://docs.squarecloud.app/en/tutorials/api/django.md): Deploy a Django app on Square Cloud: read settings from env vars, serve static files with WhiteNoise, and run Gunicorn on port 80 with a START command.
- [Deploy a FastAPI App with Uvicorn](https://docs.squarecloud.app/en/tutorials/api/fastapi.md): Deploy a FastAPI app on Square Cloud: list fastapi and uvicorn in requirements.txt, start Uvicorn on host 0.0.0.0 and port 80 with a START command, and go live.
- [Deploy a Spring Boot App (JAR)](https://docs.squarecloud.app/en/tutorials/api/spring-boot.md): Deploy a Spring Boot app on Square Cloud: read the port from PORT in application.properties, build the JAR with Maven or Gradle, then zip and upload it.
- [Run Flask or Django in Production with Gunicorn](https://docs.squarecloud.app/en/tutorials/python/how-to-use-gunicorn.md): Gunicorn for Flask and Django on Square Cloud: bind to 0.0.0.0:80, size workers to your RAM with gunicorn.conf.py and set the START command in your config.
- [Create and Connect a Managed Database](https://docs.squarecloud.app/en/tutorials/how-to-deploy-your-database.md): Managed database on Square Cloud: create a PostgreSQL, MongoDB, MySQL or Redis instance, get its connection string and TLS certificate, and connect from code.
- [Host pgAdmin 4 for Your PostgreSQL Database](https://docs.squarecloud.app/en/tutorials/how-to-deploy-pgadmin.md): pgAdmin 4 hosting on Square Cloud: run it with Gunicorn, set config_local.py and the setup email and password, then manage PostgreSQL from any browser.
- [Self-Host n8n on Square Cloud](https://docs.squarecloud.app/en/tutorials/how-to-deploy-n8n.md): n8n self-hosting on Square Cloud: a pinned package.json, port 80 and webhook URL variables, the config file and creating your owner account after deploy.
- [Deploy Evolution API (WhatsApp API)](https://docs.squarecloud.app/en/tutorials/how-to-deploy-evolution-api.md): Evolution API on Square Cloud: host this WhatsApp API with a managed PostgreSQL database, run its migrations, set port 80, a global API key and Redis cache.
- [Self-Host Uptime Kuma for Uptime Monitoring](https://docs.squarecloud.app/en/tutorials/how-to-deploy-uptime-kuma.md): Uptime Kuma self-hosted on Square Cloud: download the ready project.zip, set your subdomain in the config file and deploy your uptime monitor in minutes.
- [Run Selenium with Headless Chromium](https://docs.squarecloud.app/en/tutorials/how-to-deploy-your-selenium-application.md): Selenium automation on Square Cloud: run a Python script with headless Chromium and ChromeDriver, the flags containers need, requirements.txt and deploy.
- [Validate Python Data with Pydantic](https://docs.squarecloud.app/en/tutorials/python/how-to-validate-data-with-pydantic.md): Pydantic data validation in Python: BaseModel, dataclasses, strict mode, nested models, EmailStr and pydantic-settings to check environment variables at boot.
- [Fix python-telegram-bot NetworkError with aiohttp](https://docs.squarecloud.app/en/tutorials/python/how-to-change-ptb-connection.md): python-telegram-bot NetworkError fix: swap the default httpx backend for aiohttp with ptbcontrib's AiohttpRequest, with examples for Bot and ApplicationBuilder.
- [Migrate from Heroku to Square Cloud](https://docs.squarecloud.app/en/articles/migrating-from-heroku.md): Migrate from Heroku to Square Cloud: map your Procfile, Config Vars, Postgres and logs, deploy with the CLI and point your custom domain.
- [Migrate from Railway to Square Cloud](https://docs.squarecloud.app/en/articles/migrating-from-railway.md): Migrate from Railway to Square Cloud: map railway.json, variables and database plugins, deploy with the CLI and move to flat monthly plan pricing.
- [Deploy your first app with the CLI](https://docs.squarecloud.app/en/cli-reference/quickstart.md): Install the Square Cloud CLI, log in, deploy a project with squarecloud upload, read its logs and ship every later change with squarecloud commit.
- [Install the Square Cloud CLI](https://docs.squarecloud.app/en/cli-reference/installation.md): Install the Square Cloud CLI on macOS, Linux, WSL or Windows with one command, check that it runs, update it and choose the language of its messages.
- [Log in to the Square Cloud CLI](https://docs.squarecloud.app/en/cli-reference/authentication.md): Log in to the Square Cloud CLI from the browser, with an API key or through SQUARECLOUD_API_KEY in CI, check the current account and renew an expired key.
- [Upload and update apps from the CLI](https://docs.squarecloud.app/en/cli-reference/deploy.md): Deploy a folder as a new Square Cloud app with squarecloud upload, send changes with squarecloud commit and check what the zip contains with squarecloud zip.
- [Deploy from GitHub with the CLI](https://docs.squarecloud.app/en/cli-reference/github-deploys.md): Link a GitHub repository to a Square Cloud app with squarecloud app deploy, through the GitHub App or a webhook, and list the deploys each push started.
- [Manage applications from the CLI](https://docs.squarecloud.app/en/cli-reference/apps.md): List your Square Cloud applications, show their details, start, stop or restart them and delete the ones you no longer need with squarecloud app.
- [Read app logs from the CLI](https://docs.squarecloud.app/en/cli-reference/logs.md): Print the latest logs of a Square Cloud application with squarecloud app logs, or follow its output and status changes live in the terminal with app realtime.
- [Check app status and metrics](https://docs.squarecloud.app/en/cli-reference/status-and-metrics.md): Check the CPU, memory, disk and uptime of one or every Square Cloud application with squarecloud app status, and print the last 24 hours with app metrics.
- [Manage environment variables from the CLI](https://docs.squarecloud.app/en/cli-reference/environment-variables.md): List, set, remove or replace the environment variables of a Square Cloud application with squarecloud app env, including loading them from a .env file.
- [Manage app files from the CLI](https://docs.squarecloud.app/en/cli-reference/files.md): List, read, write, move and delete the files of a running Square Cloud application with squarecloud app file, without a commit. Binary files stay intact.
- [Back up and restore snapshots from the CLI](https://docs.squarecloud.app/en/cli-reference/snapshots.md): Create, download, list and restore snapshots of Square Cloud applications and databases with squarecloud app snapshot and squarecloud db snapshot.
- [Set up custom domains from the CLI](https://docs.squarecloud.app/en/cli-reference/domains.md): Attach a custom domain to a Square Cloud website, read the DNS records to create, and list every domain and shared domain of your account from the terminal.
- [Read edge analytics from the CLI](https://docs.squarecloud.app/en/cli-reference/edge-analytics.md): Read the traffic, errors, request logs and latency of a Square Cloud website at the edge with squarecloud app network, and purge its edge cache.
- [Manage databases from the CLI](https://docs.squarecloud.app/en/cli-reference/databases.md): Create, inspect, resize, start, stop and delete Square Cloud databases with squarecloud db, and print or rotate their TLS certificate and password.
- [Manage workspaces from the CLI](https://docs.squarecloud.app/en/cli-reference/workspaces.md): Create, inspect, leave and delete Square Cloud workspaces with squarecloud workspace, and choose which of your applications each workspace can see.
- [Manage workspace members from the CLI](https://docs.squarecloud.app/en/cli-reference/workspace-members.md): Invite people to a Square Cloud workspace with a single-use code, change their permission group and remove them with squarecloud workspace member.
- [Global flags, exit codes and CI](https://docs.squarecloud.app/en/cli-reference/global-flags-and-ci.md): Use the Square Cloud CLI's global flags, JSON output, exit codes and debug tracing, check platform health, and run the CLI safely in scripts and CI.
- [Square Cloud extension for VS Code](https://docs.squarecloud.app/en/vscode-extension/installation.md): Install the Square Cloud extension for VS Code or Open VSX editors, connect your account with a browser code and follow the Get Started walkthrough.
- [Square Cloud VS Code extension features](https://docs.squarecloud.app/en/vscode-extension/features.md): Deploy, manage and monitor Square Cloud apps, databases and workspaces from the VS Code side bar, with snapshots, edge analytics and config file IntelliSense.
- [VS Code extension commands and settings](https://docs.squarecloud.app/en/vscode-extension/commands.md): Run every Square Cloud extension command from the VS Code command palette or side bar, and find its settings, refresh behavior and fixes for common problems.
- [Official SDKs for JavaScript, Python and Go](https://docs.squarecloud.app/en/sdks/introduction.md): Official Square Cloud SDKs for JavaScript, Python and Go, plus the Blob Storage SDK: pick one, install it, set your API key and make a first call.
- [JavaScript SDK: quickstart and client](https://docs.squarecloud.app/en/sdks/js/client.md): Install the Square Cloud JavaScript SDK (@squarecloud/api v6), create a client with your API key and follow its conventions: ids, workspace apps and timeouts.
- [JavaScript SDK: manage applications](https://docs.squarecloud.app/en/sdks/js/managing_application.md): Fetch, inspect and control your applications with @squarecloud/api: details, status, start, stop, restart, logs, metrics, domains, load balancers and deletion.
- [JavaScript SDK: upload and commit files](https://docs.squarecloud.app/en/sdks/js/commit_and_upload.md): Create applications from a zip with apps.create() and send files to an existing application with apps.commit(), from a path, a Blob or bytes.
- [JavaScript SDK: app file manager](https://docs.squarecloud.app/en/sdks/js/managing_files.md): List, read, write, move and delete the files of an application with api.apps.files. Content travels as base64, so binary files round-trip byte for byte.
- [JavaScript SDK: environment variables](https://docs.squarecloud.app/en/sdks/js/environment_variables.md): Read, add, replace and remove the environment variables of a Square Cloud application with api.apps.envs in the JavaScript SDK (@squarecloud/api).
- [JavaScript SDK: GitHub deploys](https://docs.squarecloud.app/en/sdks/js/deploys.md): Deploy from GitHub with api.apps.deploys: set a webhook, link a repository through the Square Cloud GitHub App, and read the deploy history.
- [JavaScript SDK: analytics, DNS and domains](https://docs.squarecloud.app/en/sdks/js/network.md): Read edge analytics, errors, request logs and performance of a web application, check DNS, set a custom domain and purge the cache with api.apps.network.
- [JavaScript SDK: live logs and status](https://docs.squarecloud.app/en/sdks/js/realtime.md): Stream an application's live logs, status and system events with api.apps.realtime(), an async iterable that merges status frames and reconnects on its own.
- [JavaScript SDK: snapshots and backups](https://docs.squarecloud.app/en/sdks/js/snapshots.md): List, create and restore snapshots of applications and databases, list every snapshot of the account, and download a snapshot file with api.downloadSnapshot().
- [JavaScript SDK: managed databases](https://docs.squarecloud.app/en/sdks/js/databases.md): Create, inspect, update, start, stop and delete managed databases, read their status and metrics, and manage their credentials with api.databases.
- [JavaScript SDK: workspaces and members](https://docs.squarecloud.app/en/sdks/js/workspaces.md): Create and manage workspaces, invite members, set their roles and share applications with api.workspaces. Act on a shared app with its composite id.
- [JavaScript SDK: AI Gateway chat](https://docs.squarecloud.app/en/sdks/js/ai.md): Call the Square Cloud AI Gateway from @squarecloud/api with api.ai.chat(): OpenAI-compatible chat completions, without streaming.
- [JavaScript SDK: errors and retries](https://docs.squarecloud.app/en/sdks/js/errors.md): Handle SquareCloudAPIError in @squarecloud/api: status, code and message, the SDK's own error codes, retries, timeouts and rate limits.
- [JavaScript SDK: migrating from v5 to v6](https://docs.squarecloud.app/en/sdks/js/migrating_to_v6.md): Upgrade @squarecloud/api from v5 to v6: plain data instead of classes, ids as the first argument, one error class, timeouts, retries and a method table.
- [JavaScript SDK: migrating from v4 to v5](https://docs.squarecloud.app/en/sdks/js/migrating_to_v5.md): Upgrade @squarecloud/api from v4 to v5: client.users and backups removed, a new apps.create() result and dns() shape, with the smallest patches needed.
- [Python SDK: quickstart and client](https://docs.squarecloud.app/en/sdks/py/client.md): Install the Square Cloud Python SDK (squarecloud-api 5), create a sync or async client with your API key and follow its conventions: ids, dates and timeouts.
- [Python SDK: manage applications](https://docs.squarecloud.app/en/sdks/py/managing_application.md): Fetch, inspect and control your applications with squarecloud-api: details, status, start, stop, restart, logs, metrics, domains, load balancers and deletion.
- [Python SDK: upload and commit files](https://docs.squarecloud.app/en/sdks/py/commit_and_upload.md): Create applications from a zip with apps.create() and send files to an existing application with apps.commit(), from a path, bytes or a binary file object.
- [Python SDK: app file manager](https://docs.squarecloud.app/en/sdks/py/managing_files.md): List, read, write, move and delete the files of an application with client.apps.files. Content travels as base64, so binary files round-trip byte for byte.
- [Python SDK: environment variables](https://docs.squarecloud.app/en/sdks/py/environment_variables.md): Read, add, replace and remove the environment variables of a Square Cloud application with client.apps.envs in the Python SDK (squarecloud-api).
- [Python SDK: GitHub deploys](https://docs.squarecloud.app/en/sdks/py/deploys.md): Deploy from GitHub with client.apps.deploys: set a webhook, link a repository through the Square Cloud GitHub App, and read the deploy history.
- [Python SDK: analytics, DNS and domains](https://docs.squarecloud.app/en/sdks/py/network.md): Read edge analytics, errors, request logs and performance of a web application, check DNS, set a custom domain and purge the cache with client.apps.network.
- [Python SDK: live logs and status](https://docs.squarecloud.app/en/sdks/py/realtime.md): Stream a Square Cloud app's live logs, status and system events with client.apps.realtime() in the Python SDK, sync or async, with automatic reconnection.
- [Python SDK: snapshots and backups](https://docs.squarecloud.app/en/sdks/py/snapshots.md): List, create and restore app and database snapshots, list every snapshot of the account, and download a snapshot file with client.download_snapshot().
- [Python SDK: managed databases](https://docs.squarecloud.app/en/sdks/py/databases.md): Create, inspect, update, start, stop and delete managed databases, read their status and metrics, and manage their credentials with client.databases.
- [Python SDK: workspaces and members](https://docs.squarecloud.app/en/sdks/py/workspaces.md): Create and manage workspaces, invite members, set their roles and share applications with client.workspaces. Act on a shared app with its composite id.
- [Python SDK: AI Gateway chat](https://docs.squarecloud.app/en/sdks/py/ai.md): Call the Square Cloud AI Gateway from squarecloud-api with client.ai.chat(): OpenAI-compatible chat completions, without streaming.
- [Python SDK: errors and retries](https://docs.squarecloud.app/en/sdks/py/errors.md): Handle SquareCloudAPIError in squarecloud-api: status, code and message, the SDK's own error codes, retries, timeouts and rate limits.
- [Python SDK: migrating from v4 to v5](https://docs.squarecloud.app/en/sdks/py/migrating_to_v5.md): Upgrade squarecloud-api from v4 to v5: a sync client with an async variant, plain dicts, methods grouped by resource, one exception class and a method table.
- [Go SDK: quickstart and client](https://docs.squarecloud.app/en/sdks/go/client.md): Install the Square Cloud Go SDK (sdk-api-go v3), create a client with your API key and follow its conventions: context, ids, workspace apps, dates and timeouts.
- [Go SDK: manage applications](https://docs.squarecloud.app/en/sdks/go/managing_application.md): Fetch, inspect and control your applications with the Go SDK: details, status, start, stop, restart, logs, metrics, domains, load balancers and deletion.
- [Go SDK: upload and commit files](https://docs.squarecloud.app/en/sdks/go/commit_and_upload.md): Create applications from a zip with c.Apps.Create and send files to an existing application with c.Apps.Commit, streamed from any io.Reader.
- [Go SDK: app file manager](https://docs.squarecloud.app/en/sdks/go/managing_files.md): List, read, write, move and delete the files of an application with c.Apps.Files. Content travels as base64, so text and binary files round-trip byte for byte.
- [Go SDK: environment variables](https://docs.squarecloud.app/en/sdks/go/environment_variables.md): Read, add, replace and remove the environment variables of a Square Cloud application with c.Apps.Envs in the Go SDK, returned as a map of strings.
- [Go SDK: GitHub deploys](https://docs.squarecloud.app/en/sdks/go/deploys.md): Deploy from GitHub with c.Apps.Deploys: set a webhook, link a repository through the Square Cloud GitHub App, and read the deploy history.
- [Go SDK: analytics, DNS and domains](https://docs.squarecloud.app/en/sdks/go/network.md): Read edge analytics, errors, request logs and performance of a web application, check DNS, set a custom domain and purge the cache with c.Apps.Network.
- [Go SDK: live logs and status](https://docs.squarecloud.app/en/sdks/go/realtime.md): Stream an application's live logs, status and system events with c.Apps.Realtime, an iterator that merges status frames and reconnects on its own.
- [Go SDK: snapshots and backups](https://docs.squarecloud.app/en/sdks/go/snapshots.md): List, create and restore snapshots of applications and databases, list every snapshot of the account, and download a snapshot file with c.DownloadSnapshot.
- [Go SDK: managed databases](https://docs.squarecloud.app/en/sdks/go/databases.md): Create, inspect, update, start, stop and delete managed databases, read their status and metrics, and manage their credentials with c.Databases.
- [Go SDK: workspaces and members](https://docs.squarecloud.app/en/sdks/go/workspaces.md): Create and manage workspaces, invite members, set their roles and share applications with c.Workspaces. Act on a shared app with its composite id.
- [Go SDK: AI Gateway chat](https://docs.squarecloud.app/en/sdks/go/ai.md): Call the Square Cloud AI Gateway from the Go SDK (sdk-api-go) with c.AI.Chat: OpenAI-compatible chat completions, without streaming.
- [Go SDK: errors and retries](https://docs.squarecloud.app/en/sdks/go/errors.md): Handle *APIError in the Go SDK: status, code and message, errors.As and errors.Is, the SDK's own codes, the Code constants, retries, timeouts and rate limits.
- [Go SDK: migrating from v2 to v3](https://docs.squarecloud.app/en/sdks/go/migrating_to_v3.md): Upgrade the Square Cloud Go SDK from v2 to v3: one package, a concrete *Client, ctx first, resource groups, one error type and a method-by-method table.
- [Blob SDK: install and create the client](https://docs.squarecloud.app/en/sdks/blob/client.md): Install @squarecloud/blob and create a SquareCloudBlob client with an API key or an upload token. The only option is maxRetries.
- [Blob SDK: uploads and upload tokens](https://docs.squarecloud.app/en/sdks/blob/uploads.md): Upload files with put(): file paths, Blob/File or bytes, automatic multipart uploads above 90 MiB, and upload tokens for uploading straight from the browser.
- [Blob SDK: manage objects and links](https://docs.squarecloud.app/en/sdks/blob/objects.md): List, inspect, update, delete, copy and move Blob Storage objects with the @squarecloud/blob SDK, and get permanent or temporary download links.
- [Blob SDK: share links](https://docs.squarecloud.app/en/sdks/blob/sharing.md): Create, list and revoke Blob Storage share links with @squarecloud/blob, with expiration, download limits and passwords, and compare them with downloadUrl().
- [Blob SDK: prefix rules and usage stats](https://docs.squarecloud.app/en/sdks/blob/rules_and_stats.md): Read and replace per-prefix Blob Storage rules with @squarecloud/blob (visibility, expiration, size, extensions, auto-delete) and read account usage stats.
- [Blob SDK: S3 gateway client](https://docs.squarecloud.app/en/sdks/blob/s3.md): Get S3 credentials with s3Credentials() and a ready-to-use S3Client with s3() to reach Blob Storage through the S3-compatible gateway.
- [Blob SDK: errors and retries](https://docs.squarecloud.app/en/sdks/blob/errors.md): SquareCloudBlobError, the BlobErrorCode list, network errors that are not wrapped, and exactly which calls @squarecloud/blob retries.
- [Blob SDK: migrating from v3 to v4](https://docs.squarecloud.app/en/sdks/blob/migrating_to_v4.md): What changed in @squarecloud/blob 4.0.0: a safer retry policy, fewer default retries, an optional SavedRule.active_from and a consistent one-id batch delete.
- [Square Cloud API: base URL and first request](https://docs.squarecloud.app/en/api-reference/introduction.md): Start with the Square Cloud REST API: the v2 base URL, the Authorization header, a first curl request, the response envelope, IDs, scopes and error handling.
- [API authentication, keys and scopes](https://docs.squarecloud.app/en/api-reference/authentication.md): Authenticate to the Square Cloud API with an API key in the Authorization header, pick the scopes each endpoint needs and limit a key to specific resources.
- [API error codes and how to fix them](https://docs.squarecloud.app/en/api-reference/errors.md): Every error code the Square Cloud API returns, grouped by area, with its HTTP status, what it means and what to do next, plus the rules for retries.
- [API rate limits and regional restrictions](https://docs.squarecloud.app/en/api-reference/limitations-and-restrictions.md): Per-plan request limits of the Square Cloud API, the countries blocked by sanctions or regulations, and the countries that must solve a captcha first.
- [Square Cloud API OpenAPI specification](https://docs.squarecloud.app/en/api-reference/openapi.md): Get the machine-readable OpenAPI specification of the Square Cloud API at GET /v2/openapi.json to generate clients or import it into Postman or Insomnia.
- [Get account information](https://docs.squarecloud.app/en/api-reference/endpoint/users/me.md): Get your account in one call with GET /v2/users/me: profile, plan, memory usage and every application and database you own, ready for an overview page.
- [List all account snapshots](https://docs.squarecloud.app/en/api-reference/endpoint/users/snapshots.md): List the automatic snapshots of all your applications or databases with GET /v2/users/snapshots, with size, date and download URL. Needs an active plan.
- [List all domains](https://docs.squarecloud.app/en/api-reference/endpoint/apps/domains.md): List every hostname across your applications with GET /v2/apps/domains: custom domains first, then the default squareweb.app subdomains, each with its app.
- [List load balancers](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/load-balancers.md): List the account's custom domains and the applications serving each with GET /v2/apps/load-balancers, plus the plan's limit of apps per domain.
- [Get service status](https://docs.squarecloud.app/en/api-reference/endpoint/service/status.md): Check the overall health of the Square Cloud platform with GET /v2/service/status. It is public, needs no API key and is served from a 5-minute cache.
- [Upload application](https://docs.squarecloud.app/en/api-reference/endpoint/apps/upload.md): Create and deploy a new application from a .zip of up to 100 MB with POST /v2/apps. The runtime is detected automatically; use commit for later changes.
- [All applications status](https://docs.squarecloud.app/en/api-reference/endpoint/apps/status-all.md): Get the live CPU, RAM and running state of every application you own with GET /v2/apps/status. Pass workspaceId to list a workspace's apps instead.
- [Get application info](https://docs.squarecloud.app/en/api-reference/endpoint/apps/info.md): Get an application's metadata with GET /v2/apps/{app_id}: name, owner, cluster, allocated RAM, language and domain. Works for workspace-shared apps too.
- [Get application status](https://docs.squarecloud.app/en/api-reference/endpoint/apps/status.md): Get an application's live CPU, RAM, storage, network and uptime with GET /v2/apps/{app_id}/status. Pass rawData=true for numbers instead of strings.
- [Get application logs](https://docs.squarecloud.app/en/api-reference/endpoint/apps/logs.md): Get a point-in-time snapshot of an application's recent stdout and stderr with GET /v2/apps/{app_id}/logs. For live logs, use the realtime SSE stream.
- [Stream real-time logs and metrics (SSE)](https://docs.squarecloud.app/en/api-reference/endpoint/apps/realtime.md): Open a Server-Sent Events stream with GET /v2/apps/{app_id}/realtime for live logs, metrics, status and deploy progress. A connection lasts up to 10 minutes.
- [Get application metrics](https://docs.squarecloud.app/en/api-reference/endpoint/apps/metrics.md): Get an application's CPU, RAM and network history with GET /v2/apps/{app_id}/metrics: up to 288 points over the last 24 hours, one every 5 minutes.
- [Start application](https://docs.squarecloud.app/en/api-reference/endpoint/apps/start.md): Start a stopped application with POST /v2/apps/{app_id}/start. Returns 409 when it is already running, and it never deploys new code.
- [Restart application](https://docs.squarecloud.app/en/api-reference/endpoint/apps/restart.md): Restart an application with POST /v2/apps/{app_id}/restart, stopping and starting it again. Call it after a commit so the new files take effect.
- [Stop application](https://docs.squarecloud.app/en/api-reference/endpoint/apps/stop.md): Stop a running application with POST /v2/apps/{app_id}/stop, keeping its files, variables and configuration. Returns 409 when it is already stopped.
- [Commit files to an application](https://docs.squarecloud.app/en/api-reference/endpoint/apps/commit.md): Push a single file or a .zip into an existing application with POST /v2/apps/{app_id}/commit. Files go up to 100 MB, and the app does not restart by itself.
- [Delete application](https://docs.squarecloud.app/en/api-reference/endpoint/apps/delete.md): Permanently delete an application with DELETE /v2/apps/{app_id}. It releases its custom domain, cannot be undone and is refused while a restore runs.
- [List environment variables](https://docs.squarecloud.app/en/api-reference/endpoint/apps/envs/get.md): Read an application's environment variables as a key-value object with GET /v2/apps/{app_id}/envs. Returns an empty object when none are set.
- [Add or edit environment variables](https://docs.squarecloud.app/en/api-reference/endpoint/apps/envs/add_n_edit.md): Add or update environment variables with POST /v2/apps/{app_id}/envs. Variables left out of the body stay untouched, which suits rotating a single key.
- [Replace all environment variables](https://docs.squarecloud.app/en/api-reference/endpoint/apps/envs/overwrite.md): Replace an application's whole environment with PUT /v2/apps/{app_id}/envs: variables not in the body are deleted, and an empty envs object wipes all.
- [Remove environment variables](https://docs.squarecloud.app/en/api-reference/endpoint/apps/envs/remove.md): Delete one or more environment variables by key with DELETE /v2/apps/{app_id}/envs. Missing keys are ignored and the remaining variables are returned.
- [List application files](https://docs.squarecloud.app/en/api-reference/endpoint/apps/filemanager/list.md): List the files and directories at a path inside an application with GET /v2/apps/{app_id}/files, each with its type, size and last-modified time.
- [Read an application file](https://docs.squarecloud.app/en/api-reference/endpoint/apps/filemanager/content.md): Read one file of up to 10 MB from an application with GET /v2/apps/{app_id}/files/content. Send encoding=base64, since the Buffer format is deprecated.
- [Create or update an application file](https://docs.squarecloud.app/en/api-reference/endpoint/apps/filemanager/put.md): Create or overwrite a file in an application with PUT /v2/apps/{app_id}/files. Send base64 content for binary files, up to 10 MB each, with no restart.
- [Move or rename an application file](https://docs.squarecloud.app/en/api-reference/endpoint/apps/filemanager/patch.md): Move or rename a file inside an application with PATCH /v2/apps/{app_id}/files, from path to to, without re-uploading it or restarting the app.
- [Delete an application file](https://docs.squarecloud.app/en/api-reference/endpoint/apps/filemanager/delete.md): Delete a single file from an application by path with DELETE /v2/apps/{app_id}/files. It takes effect at once, without restarting or redeploying the app.
- [List deployments](https://docs.squarecloud.app/en/api-reference/endpoint/apps/deploy/list.md): List the recent Git deploys of an application with GET /v2/apps/{app_id}/deployments, with each state from pending to success, or the error code.
- [Get current deployment](https://docs.squarecloud.app/en/api-reference/endpoint/apps/deploy/info.md): See how an application is wired for Git deploys with GET /v2/apps/{app_id}/deployments/current: its GitHub App repository, a legacy webhook, or both.
- [Set GitHub webhook](https://docs.squarecloud.app/en/api-reference/endpoint/apps/deploy/webhooks.md): Connect an application to a GitHub repository with a personal access token via POST /v2/apps/{app_id}/deploy/webhook, or send @ to remove the webhook.
- [Link GitHub App repository](https://docs.squarecloud.app/en/api-reference/endpoint/apps/deploy/github-app-link.md): Link a GitHub repository and branch to an application with POST /v2/apps/{app_id}/deploy/github-app, so every push to that branch deploys it.
- [Unlink GitHub App repository](https://docs.squarecloud.app/en/api-reference/endpoint/apps/deploy/github-app-unlink.md): Unlink the GitHub App repository of an application with DELETE /v2/apps/{app_id}/deploy/github-app. Pushes stop deploying; running code is untouched.
- [Set custom domain](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/custom.md): Attach a custom domain to an application with POST /v2/apps/{app_id}/network/custom, or send @ to remove it. Available on Standard, Pro and Enterprise.
- [Get custom domain DNS records](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/dns.md): Get the TXT and CNAME records a custom domain needs for validation and SSL with GET /v2/apps/{app_id}/network/dns, to add at your domain registrar.
- [Get website traffic analytics](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/analytics.md): Get edge traffic analytics for an application's domains with GET /v2/apps/{app_id}/network/analytics: requests, bandwidth, visitors and breakdowns.
- [Get edge request logs](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/logs.md): Get per-request edge logs for an application's domains with GET /v2/apps/{app_id}/network/logs, up to 7 days back. Available on Pro and Enterprise.
- [Get edge error breakdown](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/errors.md): Get edge error counts by status, path, method and time with GET /v2/apps/{app_id}/network/errors. Only 5xx by default; include_4xx=true adds 4xx.
- [Get edge and origin latency](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/performance.md): Get edge and origin latency percentiles with GET /v2/apps/{app_id}/network/performance, by country, colo and slowest path. For Pro and Enterprise.
- [Purge an application's edge cache](https://docs.squarecloud.app/en/api-reference/endpoint/apps/network/purge_cache.md): Clear every cached edge response for an application's domains with POST /v2/apps/{app_id}/network/purge_cache, so the next request is served fresh.
- [List application snapshots](https://docs.squarecloud.app/en/api-reference/endpoint/apps/snapshots/list.md): List the stored snapshots of an application with GET /v2/apps/{app_id}/snapshots, each with its size, date, download URL and the IDs to restore it.
- [Create an application snapshot](https://docs.squarecloud.app/en/api-reference/endpoint/apps/snapshots/create.md): Back up an application's files as a .zip with POST /v2/apps/{app_id}/snapshots. Returns a download URL, or 202 while a large snapshot keeps generating.
- [Restore an application snapshot](https://docs.squarecloud.app/en/api-reference/endpoint/apps/snapshots/restore.md): Roll an application's files back to a snapshot with POST /v2/apps/{app_id}/snapshots/restore, using the snapshotId and versionId from the list.
- [Create database](https://docs.squarecloud.app/en/api-reference/endpoint/databases/create.md): Create a managed MongoDB, MySQL, PostgreSQL or Redis database with POST /v2/databases. The password and certificate are returned once, so save them.
- [All databases status](https://docs.squarecloud.app/en/api-reference/endpoint/databases/status-all.md): Get the live CPU, RAM and running state of every database you own in one call with GET /v2/databases/status, instead of one request per database.
- [Get database info](https://docs.squarecloud.app/en/api-reference/endpoint/databases/info.md): Get a database's metadata with GET /v2/databases/{database_id}: name, owner, cluster, allocated RAM, engine type and port, without live usage.
- [Get database status](https://docs.squarecloud.app/en/api-reference/endpoint/databases/status.md): Get a database's live CPU, RAM, network, storage and uptime with GET /v2/databases/{database_id}/status. Pass rawData=true for numbers, not strings.
- [Get database metrics](https://docs.squarecloud.app/en/api-reference/endpoint/databases/metrics.md): Get a database's CPU, RAM and network history with GET /v2/databases/{database_id}/metrics: up to 288 points over 24 hours, one every 5 minutes.
- [Start database](https://docs.squarecloud.app/en/api-reference/endpoint/databases/start.md): Start a stopped database with POST /v2/databases/{database_id}/start. It comes back with the same connection URL, port and credentials as before.
- [Stop database](https://docs.squarecloud.app/en/api-reference/endpoint/databases/stop.md): Stop a running database with POST /v2/databases/{database_id}/stop. Its data is kept, and it starts again with the same credentials and connection URL.
- [Edit database](https://docs.squarecloud.app/en/api-reference/endpoint/databases/edit.md): Rename a database or change its memory with PATCH /v2/databases/{database_id}, without restarting it or changing its credentials and connection URL.
- [Delete database](https://docs.squarecloud.app/en/api-reference/endpoint/databases/delete.md): Permanently delete a database and release its DNS record with DELETE /v2/databases/{database_id}. There is no confirmation, so take a snapshot first.
- [Get database TLS certificate](https://docs.squarecloud.app/en/api-reference/endpoint/databases/credentials/get_certificate.md): Get a database's TLS file with GET /v2/databases/{database_id}/credentials/certificate: a base64 PEM with the private key and certificate.
- [Reset database password or certificate](https://docs.squarecloud.app/en/api-reference/endpoint/databases/credentials/reset.md): Rotate a database's password or TLS certificate with POST /v2/databases/{database_id}/credentials/reset. A new password is shown only once.
- [List database snapshots](https://docs.squarecloud.app/en/api-reference/endpoint/databases/snapshots/list.md): List a database's snapshots, newest first, with GET /v2/databases/{database_id}/snapshots: size, date, download URL and the IDs to restore each one.
- [Create a database snapshot](https://docs.squarecloud.app/en/api-reference/endpoint/databases/snapshots/create.md): Back up a database's data with POST /v2/databases/{database_id}/snapshots. Returns a download URL valid for 1 hour, or 202 while it keeps generating.
- [Restore a database snapshot](https://docs.squarecloud.app/en/api-reference/endpoint/databases/snapshots/restore.md): Overwrite a database's data with a snapshot using POST /v2/databases/{database_id}/snapshots/restore. The snapshot's engine must match the database.
- [List workspaces](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/list.md): List every workspace you own or belong to with GET /v2/workspaces, each with its members, roles and shared applications. Empty when you have none.
- [Get workspace](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/get.md): Get one workspace with GET /v2/workspaces/{workspaceId}: owner, members and roles, shared applications and creation date. Non-members get a 404.
- [Create workspace](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/create.md): Create a workspace with POST /v2/workspaces to share applications with other Square Cloud accounts by role. Available on Standard, Pro and Enterprise.
- [Delete workspace](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/delete.md): Delete a workspace and its member list with DELETE /v2/workspaces. Only the owner can do it, and shared applications keep running under their owner.
- [Leave workspace](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/leave.md): Leave a workspace you are a member of with DELETE /v2/workspaces/leave, losing access to its shared applications at once. Owners delete it instead.
- [Get a workspace invite code](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/members/code.md): Generate a single-use invite code with GET /v2/workspaces/members/code and give it to a workspace owner, who adds you with it. It expires in 5 minutes.
- [Invite a workspace member](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/members/invite.md): Add a member to a workspace with POST /v2/workspaces/members using their invite code, and assign a role: view, manager, maintain or admin. Owner only.
- [Change a workspace member's role](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/members/perms.md): Change a workspace member's role with PATCH /v2/workspaces/members to view, manager, maintain or admin. It applies at once; only the owner can call it.
- [Remove a workspace member](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/members/kick.md): Remove a member from a workspace with DELETE /v2/workspaces/members, revoking their access to every shared application at once. Only the owner can.
- [Share an application with a workspace](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/apps/add.md): Share an application you own with a workspace you own via POST /v2/workspaces/applications, so members get access by role without a transfer.
- [Remove an application from a workspace](https://docs.squarecloud.app/en/api-reference/endpoint/workspace/apps/remove.md): Stop sharing an application with a workspace via DELETE /v2/workspaces/applications. Members lose access; the app keeps running under its owner.
- [OpenAI-compatible AI Gateway (beta)](https://docs.squarecloud.app/en/api-reference/ai-gateway.md): Use Square Cloud's hosted cubic model in your own products through the OpenAI-compatible POST /v2/ai/chat/completions, with tool calling and web search.
- [Blob Storage API quickstart](https://docs.squarecloud.app/en/blob-reference/quickstart.md): Upload and download your first file with the Blob Storage API: the v1 base URL, the Authorization header, a curl upload, its response and a download link.
- [Blob Storage API authentication](https://docs.squarecloud.app/en/blob-reference/authentication.md): Authenticate to the Blob Storage API with an API key or a short-lived upload token in the Authorization header, and pick the scopes each route needs.
- [Blob Storage API error codes](https://docs.squarecloud.app/en/blob-reference/errors.md): Every error code the Blob Storage API returns, with its HTTP status and what to do about it, plus when to retry with backoff and when to fix the request.
- [Blob Storage S3 compatibility](https://docs.squarecloud.app/en/blob-reference/s3-compatibility.md): Use aws-cli, boto3, rclone and the AWS SDKs with Blob Storage through the S3-compatible gateway: endpoint, buckets, supported operations and limits.
- [Blob Storage links and sharing](https://docs.squarecloud.app/en/blob-reference/links-and-sharing.md): Public URLs, temporary links and share links in Blob Storage: when to use each, how long they last and what happens when a file changes visibility.
- [Upload a file to Blob Storage](https://docs.squarecloud.app/en/blob-reference/endpoint/post.md): Upload a file of up to 100 MB to Blob Storage with POST /v1/objects: public or private, with expiry, cache, metadata and checksum options.
- [List files in Blob Storage](https://docs.squarecloud.app/en/blob-reference/endpoint/list.md): List the files in your Blob Storage with GET /v1/objects: filter by prefix and visibility, browse folders and paginate with a cursor.
- [Get file details](https://docs.squarecloud.app/en/blob-reference/endpoint/info.md): Read the details of one file with GET /v1/objects/info: size, content type, expiry, visibility, cache, original name and metadata.
- [Update file options](https://docs.squarecloud.app/en/blob-reference/endpoint/update.md): Change the visibility, expiry, cache, disposition or metadata of up to 50 files per request with PATCH /v1/objects, without uploading them again.
- [Copy, move or rename a file](https://docs.squarecloud.app/en/blob-reference/endpoint/copy.md): Copy, move or rename a file inside Blob Storage with POST /v1/objects/copy, server-side and without downloading it. With move: true the source is removed.
- [Delete files](https://docs.squarecloud.app/en/blob-reference/endpoint/delete.md): Delete one file or up to 100 files per request from Blob Storage with DELETE /v1/objects, with per-file results for batches.
- [Create a temporary download link](https://docs.squarecloud.app/en/blob-reference/endpoint/download.md): Get a download link for any file with GET /v1/objects/download: a temporary link of up to 24 hours for private files, or the public URL.
- [Start a chunked upload](https://docs.squarecloud.app/en/blob-reference/endpoint/chunked-init.md): Open a chunked upload for files of up to 10 GiB with POST /v1/objects/chunked and get the upload token for the next calls.
- [Upload one part of a chunked upload](https://docs.squarecloud.app/en/blob-reference/endpoint/chunked-part.md): Send one part of a chunked upload with PUT /v1/objects/chunked: raw bytes, 5 to 32 MB each except the last, in any order and safe to retry on failure.
- [Get chunked upload status](https://docs.squarecloud.app/en/blob-reference/endpoint/chunked-status.md): See which parts of a chunked upload already arrived with GET /v1/objects/chunked, to resume an interrupted upload by sending only the missing parts.
- [Complete a chunked upload](https://docs.squarecloud.app/en/blob-reference/endpoint/chunked-complete.md): Seal a chunked upload with PATCH /v1/objects/chunked: the server assembles the parts it received into the final file, which then counts toward your quota.
- [Abort a chunked upload](https://docs.squarecloud.app/en/blob-reference/endpoint/chunked-abort.md): Cancel a chunked upload and discard its parts with DELETE /v1/objects/chunked. It is idempotent and needs no active plan, so you can always clean up.
- [List open chunked uploads](https://docs.squarecloud.app/en/blob-reference/endpoint/chunked-open.md): List every open chunked upload of the account with GET /v1/objects/chunked/open, including uploads started over S3, with a token to resume or abort each.
- [Get Blob Storage usage](https://docs.squarecloud.app/en/blob-reference/endpoint/stats.md): Read your Blob Storage usage with GET /v1/account/stats: files, bytes, included storage, this month's average and the estimate of any storage beyond the quota.
- [Get prefix rules](https://docs.squarecloud.app/en/blob-reference/endpoint/settings-get.md): Read the per-prefix rules of your Blob Storage account with GET /v1/account/settings: default visibility, expiry and cache, size and type limits, auto-deletion.
- [Set prefix rules](https://docs.squarecloud.app/en/blob-reference/endpoint/settings-put.md): Set rules per prefix with PUT /v1/account/settings: default visibility, expiry and cache, size and file type limits, and automatic deletion after N days.
- [Create an upload token](https://docs.squarecloud.app/en/blob-reference/endpoint/upload-tokens.md): Mint a short-lived upload token with POST /v1/upload-tokens so a browser can upload straight to Blob Storage without your API key.
- [Create a share link](https://docs.squarecloud.app/en/blob-reference/endpoint/shares-create.md): Create a share link with POST /v1/shares: valid up to 30 days, revocable, with an optional download cap and, on Pro and Enterprise, a password.
- [List share links](https://docs.squarecloud.app/en/blob-reference/endpoint/shares-list.md): List the active share links of your account with GET /v1/shares, with the expiry, remaining downloads and password status of each link still valid.
- [Revoke a share link](https://docs.squarecloud.app/en/blob-reference/endpoint/shares-delete.md): Revoke a Blob Storage share link with DELETE /v1/shares using its share id. The link answers 404 from then on, and the file itself is kept in storage.
- [Get S3 credentials](https://docs.squarecloud.app/en/blob-reference/endpoint/s3-credentials.md): Get the S3 access key pair of your API key with GET /v1/s3/credentials, to use aws-cli, boto3, rclone and the AWS SDKs with Blob Storage.

## Documentação (Português do Brasil)

- [Documentação: hospede bots, sites, APIs e bancos](https://docs.squarecloud.app/pt-br/getting-started/overview.md): Hospede bots, sites, APIs e bancos de dados (PostgreSQL, MongoDB, MySQL e Redis) com recursos dedicados. Deploy em segundos pelo dashboard, CLI ou GitHub.
- [Início rápido: seu primeiro deploy](https://docs.squarecloud.app/pt-br/getting-started/quick-start.md): Coloque sua primeira aplicação no ar em minutos: escreva um servidor web simples, adicione o arquivo de configuração e faça deploy pelo dashboard ou pela CLI.
- [Referência do arquivo de configuração squarecloud.app](https://docs.squarecloud.app/pt-br/getting-started/config-file.md): Configure sua aplicação com o arquivo squarecloud.app: MAIN, MEMORY, VERSION, DISPLAY_NAME, RUNTIME, START, SUBDOMAIN e AUTORESTART, com exemplos de bot e site.
- [Variáveis de ambiente e segredos](https://docs.squarecloud.app/pt-br/platform/environment-variables.md): Guarde tokens, chaves de API e strings de conexão como variáveis de ambiente na Square Cloud pelo dashboard, pela CLI ou pela API, e leia-as no seu código.
- [squarecloud.ignore: deixe arquivos fora do deploy](https://docs.squarecloud.app/pt-br/getting-started/squarecloud-ignore.md): Use o squarecloud.ignore para deixar arquivos fora dos deploys pela CLI e pelo VS Code: sintaxe do .gitignore, exclusões padrão como node_modules e exemplos.
- [Hospedagem de bots Discord, WhatsApp e Telegram 24/7](https://docs.squarecloud.app/pt-br/services/bots.md): Hospede seu bot de Discord, WhatsApp ou Telegram online 24/7, com CPU e RAM dedicadas, reinício automático e snapshots. Planos a partir de R$12,49/mês.
- [Hospedagem de sites e APIs com SSL e CDN](https://docs.squarecloud.app/pt-br/services/sites.md): Coloque seu site ou API no ar com SSL automático, CDN global e WAF da Cloudflare. Subdomínio squareweb.app incluso e domínio próprio a partir do Standard.
- [Hospedagem de PostgreSQL, MySQL, MongoDB e Redis](https://docs.squarecloud.app/pt-br/services/databases.md): Crie um banco PostgreSQL, MySQL, MongoDB ou Redis gerenciado em poucos cliques, com conexão TLS, snapshots e sem cobrança de tráfego. A partir do Standard.
- [Blob Storage: armazenamento compatível com S3](https://docs.squarecloud.app/pt-br/services/blob.md): Armazenamento de objetos compatível com S3: CDN global, arquivos privados, links temporários e de compartilhamento, sem cobrança de tráfego e incluso no plano.
- [Solução de problemas: erros comuns](https://docs.squarecloud.app/pt-br/platform/troubleshooting.md): Corrija erros comuns da Square Cloud: uploads recusados, sites que não carregam, EADDRINUSE, módulos ausentes, login do bot do Discord e erros de SSL do banco.
- [App não inicia: erros de deploy, site e boot](https://docs.squarecloud.app/pt-br/platform/troubleshooting/app-wont-start.md): Corrija uma aplicação que não faz deploy, não inicia ou não carrega: erros de upload, timeout na porta 80, EADDRINUSE, Cannot find module e horários em UTC.
- [Bot do Discord offline: token, intents e Lavalink](https://docs.squarecloud.app/pt-br/platform/troubleshooting/discord-bot-errors.md): Corrija erros de bot do Discord: LoginFailure e TokenInvalid, intents não permitidas, Message Content Intent, Lavalink com código 1006 e bots ficando offline.
- [Erros de conexão com banco: MySQL, MongoDB e SSL](https://docs.squarecloud.app/pt-br/platform/troubleshooting/database-connection-errors.md): Corrija erros de conexão com banco de dados: MySQL Host is not allowed, MongoNetworkError, whitelist de IP do Atlas, timeouts, ECONNREFUSED e SSL/TLS.
- [Linguagens e runtimes suportados](https://docs.squarecloud.app/pt-br/runtimes/introduction.md): Veja as linguagens e versões que a Square Cloud suporta, como RUNTIME ou MAIN define o runtime, como as dependências são instaladas e o que cada imagem inclui.
- [Hospede uma aplicação, API ou bot em Node.js](https://docs.squarecloud.app/pt-br/articles/getting-started-with-nodejs.md): Faça deploy de aplicações, APIs e bots de Discord em Node.js e TypeScript: defina MAIN e START, instale dependências do package.json e fique no ar em minutos.
- [Faça deploy de uma aplicação ou bot em Bun](https://docs.squarecloud.app/pt-br/articles/getting-started-with-bun.md): Rode aplicações e bots em Bun: adicione o bun ao package.json, inicie com npx bun no START e faça deploy no runtime Node.js com npm install automático.
- [Faça deploy de uma aplicação ou bot em Deno](https://docs.squarecloud.app/pt-br/articles/getting-started-with-deno.md): Rode aplicações e bots em Deno na Square Cloud: adicione o deno ao package.json e inicie com npx deno no START e as permissões necessárias, no runtime Node.js.
- [Como criar um package.json para Node.js](https://docs.squarecloud.app/pt-br/articles/how-to-create-your-package-json.md): Crie o package.json de uma aplicação Node.js: inicie com npm init, adicione scripts de start e dependências e veja o que a Square Cloud instala em produção.
- [Hospede uma aplicação, API ou bot em Python](https://docs.squarecloud.app/pt-br/articles/getting-started-with-python.md): Faça deploy de aplicações, APIs e bots de Discord em Python: defina o MAIN, instale dependências do requirements.txt ou pyproject.toml e fique no ar em minutos.
- [Como criar um arquivo requirements.txt](https://docs.squarecloud.app/pt-br/articles/how-to-create-your-requirements.md): Crie um requirements.txt para uma aplicação Python: gere com pip freeze dentro de um ambiente virtual, fixe as versões com == e faça deploy na Square Cloud.
- [Como criar um arquivo pyproject.toml](https://docs.squarecloud.app/pt-br/articles/how-to-create-your-pyproject.md): Crie o pyproject.toml de uma aplicação Python: declare metadados do projeto, dependências fixadas e um sistema de build para a Square Cloud instalar com pip.
- [Hospede um site estático em HTML/CSS](https://docs.squarecloud.app/pt-br/articles/getting-started-with-html.md): Hospede um site estático em HTML, CSS e JavaScript na Square Cloud: envie o index.html e os assets, adicione um 404.html ou vite.html de fallback e publique.
- [Hospede uma aplicação ou bot em Java (JAR)](https://docs.squarecloud.app/pt-br/articles/getting-started-with-java.md): Faça deploy de uma aplicação ou bot de Discord em Java: gere um JAR executável, defina o MAIN como o .jar e a Square Cloud o inicia com java -jar no JDK 25.
- [Faça deploy de uma aplicação, API ou bot em Rust](https://docs.squarecloud.app/pt-br/articles/getting-started-with-rust.md): Faça deploy de aplicações, APIs e bots em Rust: envie seu projeto Cargo com o Cargo.toml, defina MAIN=src/main.rs e compile com cargo run --release.
- [Hospede uma aplicação ou bot em Ruby](https://docs.squarecloud.app/pt-br/articles/getting-started-with-ruby.md): Hospede aplicações e bots em Ruby: inclua um Gemfile, defina o MAIN com o arquivo de entrada e a Square Cloud roda bundle install e inicia com ruby MAIN.
- [Faça deploy de uma aplicação, API ou bot em Elixir](https://docs.squarecloud.app/pt-br/articles/getting-started-with-elixir.md): Faça deploy de uma aplicação, API ou bot em Elixir: inclua o mix.exs e a Square Cloud baixa as dependências com mix deps.get e inicia com mix run --no-halt.
- [Hospede um site ou API em PHP](https://docs.squarecloud.app/pt-br/articles/getting-started-with-php.md): Hospede um site ou API em PHP na Square Cloud: defina o MAIN como index.php, deixe a Square Cloud rodar o Composer e sirva com o servidor do PHP ou Swoole.
- [Faça deploy de uma aplicação, API ou bot em Go](https://docs.squarecloud.app/pt-br/articles/getting-started-with-go.md): Faça deploy de aplicações, APIs e bots em Go: inclua go.mod e go.sum, defina MAIN como main.go e use START=go run . se o package main tiver vários arquivos.
- [Hospede uma aplicação ou bot em C# / .NET](https://docs.squarecloud.app/pt-br/articles/getting-started-with-csharp.md): Hospede aplicações e bots em C# e .NET na Square Cloud: aponte o MAIN para o .csproj e a Square Cloud restaura os pacotes e inicia com dotnet run no .NET 10.
- [Infraestrutura, uptime e segurança](https://docs.squarecloud.app/pt-br/platform/overview.md): Infraestrutura da Square Cloud: data center em Nova York com SOC 2 e ISO 27001, 10 Gbps por servidor, proteção DDoS em múltiplas camadas e 99,99% de uptime.
- [Planos e preços: Hobby, Standard, Pro e Enterprise](https://docs.squarecloud.app/pt-br/platform/plans.md): Planos a partir de R$12,49/mês: compare a RAM, as vCPUs, o Blob Storage e os recursos de cada plano, do Hobby e Standard ao Pro e Enterprise.
- [Limites de recursos: RAM, CPU, banda e armazenamento](https://docs.squarecloud.app/pt-br/platform/limitations-and-restrictions.md): Limites de recursos da Square Cloud: RAM mínima por projeto, vCPUs por RAM, banda dedicada, 10 GB de armazenamento NVMe e os status LACK_OF_RAM e LACK_OF_CPU.
- [Changelog](https://docs.squarecloud.app/pt-br/changelog.md): Descubra as últimas novidades e melhorias na Square Cloud. Acompanhe os lançamentos de produtos, otimizações de performance e muito mais.
- [Como hospedar um bot do Discord 24/7](https://docs.squarecloud.app/pt-br/tutorials/bots/discord.md): Hospede seu bot do Discord 24/7 na Square Cloud: crie o token, escreva um bot com discord.js ou discord.py, faça o deploy e mantenha-o sempre online.
- [Como hospedar um bot do WhatsApp 24/7](https://docs.squarecloud.app/pt-br/tutorials/bots/whatsapp.md): Hospede um bot do WhatsApp 24/7 na Square Cloud com whatsapp-web.js ou Baileys: escaneie o QR Code pelos logs, mantenha a sessão salva e faça o deploy.
- [Como hospedar um bot do Telegram 24/7](https://docs.squarecloud.app/pt-br/tutorials/bots/telegram.md): Hospede seu bot do Telegram 24/7 na Square Cloud: obtenha um token com o BotFather, escreva um bot com grammY ou pyTelegramBotAPI, faça o deploy e teste.
- [Como hospedar um bot do Slack](https://docs.squarecloud.app/pt-br/tutorials/bots/slack.md): Hospede um bot do Slack na Square Cloud com Bolt para JavaScript ou Python: crie os tokens, rode em Socket Mode sem URL pública, faça o deploy e teste.
- [Como criar e hospedar um bot do X (Twitter)](https://docs.squarecloud.app/pt-br/tutorials/bots/x.md): Crie e hospede um bot do X (Twitter) na Square Cloud com Node.js e twitter-api-v2: configure as chaves da API, responda a novas menções e faça o deploy.
- [Receba webhooks de votos do Top.gg](https://docs.squarecloud.app/pt-br/tutorials/topgg-webhook-config.md): Webhooks de votos do Top.gg na Square Cloud: receba votos em Node.js ou Python, verifique o HMAC do x-topgg-signature com seu secret e envie um voto de teste.
- [Hospede um servidor Lavalink para seu bot de música](https://docs.squarecloud.app/pt-br/tutorials/how-to-create-your-lavalink-server.md): Hospedagem de servidor Lavalink para bots de música do Discord: application.yml v4 com o plugin do YouTube, porta 80, senha forte e como seu bot se conecta.
- [Como hospedar um site ou uma API](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-your-website.md): Hospede um site ou uma API na Square Cloud: configure o squarecloud.app com SUBDOMAIN e porta 80, veja exemplos estáticos e de Next.js e guias de frameworks.
- [Faça deploy de uma aplicação React (build Vite)](https://docs.squarecloud.app/pt-br/tutorials/website/react.md): Faça deploy de uma aplicação React na Square Cloud: gere o build com Vite em dist/ e sirva com o runtime estático ou um pequeno servidor Node.js no seu subdomínio.
- [Faça deploy de uma aplicação Vite](https://docs.squarecloud.app/pt-br/tutorials/website/vite.md): Faça deploy de uma aplicação Vite na Square Cloud: gere o build com npm run build e sirva o dist/ com o runtime estático ou um pequeno servidor Node.js.
- [Faça deploy de uma aplicação Vue](https://docs.squarecloud.app/pt-br/tutorials/website/vue.md): Faça deploy de uma aplicação Vue na Square Cloud: crie com npm create vue@latest, gere o build em dist/ e sirva com o runtime estático ou um servidor Node.js.
- [Faça deploy de uma aplicação Angular](https://docs.squarecloud.app/pt-br/tutorials/website/angular.md): Faça deploy de uma aplicação Angular na Square Cloud: gere o build com ng build, sirva a pasta browser com o runtime estático ou Node.js, ou rode o servidor SSR.
- [Faça deploy de um site Astro](https://docs.squarecloud.app/pt-br/tutorials/website/astrojs.md): Faça deploy de um site Astro na Square Cloud: gere o build em dist/ e sirva com o runtime estático ou Node.js, ou use renderização sob demanda com @astrojs/node.
- [Faça deploy de um site Gatsby](https://docs.squarecloud.app/pt-br/tutorials/website/gatsby.md): Faça deploy de um site Gatsby na Square Cloud: gere o build com npm run build e sirva a pasta public/ com o runtime estático ou um pequeno servidor Node.js.
- [Faça deploy de uma aplicação Preact](https://docs.squarecloud.app/pt-br/tutorials/website/preact.md): Faça deploy de uma aplicação Preact na Square Cloud: crie com npm init preact, gere o build em dist/ e sirva com o runtime estático ou um servidor Node.js.
- [Faça deploy de uma aplicação SolidJS](https://docs.squarecloud.app/pt-br/tutorials/website/solidjs.md): Faça deploy de uma aplicação SolidJS na Square Cloud: rode o servidor SolidStart do .output/server/index.mjs ou sirva um build Solid e Vite no runtime estático.
- [Hospedagem Next.js: deploy de uma aplicação Next.js](https://docs.squarecloud.app/pt-br/tutorials/website/nextjs.md): Faça deploy de uma aplicação Next.js na Square Cloud: gere o build com next build, rode next start via START, compacte o projeto com .next e publique com HTTPS.
- [Faça deploy de uma aplicação Nuxt (servidor Nitro)](https://docs.squarecloud.app/pt-br/tutorials/website/nuxt.md): Faça deploy de uma aplicação Nuxt na Square Cloud: gere o build com npm run build, rode o servidor .output/server/index.mjs como MAIN ou gere um site estático.
- [Faça deploy do React Router (antigo Remix)](https://docs.squarecloud.app/pt-br/tutorials/website/remix.md): Faça deploy do React Router (antigo Remix) na Square Cloud: gere o build com npm run build, defina START=npm run start para rodar o react-router-serve e entre no ar.
- [Faça deploy de uma aplicação Qwik](https://docs.squarecloud.app/pt-br/tutorials/website/qwik.md): Faça deploy de uma aplicação Qwik City na Square Cloud: use o adaptador estático e sirva o dist/ com o runtime estático, ou o adaptador Express e o servidor dele.
- [Faça deploy de uma aplicação Ruby on Rails](https://docs.squarecloud.app/pt-br/tutorials/website/ruby-on-rails.md): Faça deploy de uma aplicação Ruby on Rails na Square Cloud: defina RAILS_MASTER_KEY, pré-compile os assets, prepare o banco e inicie o servidor com um comando START.
- [Faça deploy de uma aplicação Phoenix (Elixir)](https://docs.squarecloud.app/pt-br/tutorials/website/phoenix.md): Faça deploy de uma aplicação Phoenix na Square Cloud: defina SECRET_KEY_BASE e PHX_HOST, gere os assets e inicie o servidor em modo de produção com um comando START.
- [Hospedagem Laravel: deploy de uma aplicação Laravel](https://docs.squarecloud.app/pt-br/tutorials/api/laravel.md): Hospede uma aplicação Laravel na Square Cloud: o Composer roda sozinho e um START roda migrations e php artisan serve na porta 80, mais APP_KEY e variáveis.
- [Faça deploy de uma API Express](https://docs.squarecloud.app/pt-br/tutorials/api/express.md): Faça deploy de uma API Express na Square Cloud: leia a porta da PORT, escute em 0.0.0.0, compacte o projeto com package.json e squarecloud.app e publique com HTTPS.
- [Faça deploy de uma API Fastify](https://docs.squarecloud.app/pt-br/tutorials/api/fastify.md): Faça deploy de uma API Fastify na Square Cloud: escute em 0.0.0.0 e na variável PORT, compacte o projeto com package.json e squarecloud.app e publique com HTTPS.
- [Faça deploy de uma API NestJS](https://docs.squarecloud.app/pt-br/tutorials/api/nestjs.md): Faça deploy de uma API NestJS na Square Cloud: gere o dist/ localmente com npm run build, defina MAIN=dist/main.js e deixe o código gerado ler a variável PORT.
- [Hospedagem Flask: deploy de uma aplicação Flask](https://docs.squarecloud.app/pt-br/tutorials/api/flask.md): Faça deploy de uma aplicação Flask na Square Cloud: liste flask e gunicorn no requirements.txt, inicie o Gunicorn em 0.0.0.0:80 via START e publique com HTTPS.
- [Faça deploy de uma aplicação Django com Gunicorn](https://docs.squarecloud.app/pt-br/tutorials/api/django.md): Faça deploy de uma aplicação Django na Square Cloud: settings por variáveis de ambiente, estáticos com WhiteNoise e Gunicorn na porta 80 com um comando START.
- [Faça deploy de uma aplicação FastAPI com Uvicorn](https://docs.squarecloud.app/pt-br/tutorials/api/fastapi.md): Faça deploy de uma aplicação FastAPI na Square Cloud: liste fastapi e uvicorn no requirements.txt, inicie o Uvicorn em 0.0.0.0 na porta 80 com um START e entre no ar.
- [Faça deploy de uma aplicação Spring Boot (JAR)](https://docs.squarecloud.app/pt-br/tutorials/api/spring-boot.md): Faça deploy de uma aplicação Spring Boot na Square Cloud: leia a porta da PORT no application.properties, gere o JAR com Maven ou Gradle, compacte e envie.
- [Rode Flask ou Django em produção com Gunicorn](https://docs.squarecloud.app/pt-br/tutorials/python/how-to-use-gunicorn.md): Gunicorn para Flask e Django na Square Cloud: faça bind em 0.0.0.0:80, ajuste os workers à sua RAM com gunicorn.conf.py e defina o START na configuração.
- [Crie e conecte um banco de dados gerenciado](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-your-database.md): Banco de dados gerenciado na Square Cloud: crie um PostgreSQL, MongoDB, MySQL ou Redis, obtenha a connection string e o certificado TLS e conecte pelo código.
- [Hospede o pgAdmin 4 para seu banco de dados PostgreSQL](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-pgadmin.md): Hospedagem do pgAdmin 4 na Square Cloud: rode com Gunicorn, configure o config_local.py, o e-mail e a senha de setup e gerencie o PostgreSQL pelo navegador.
- [Hospede seu próprio n8n na Square Cloud](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-n8n.md): Self-hosting do n8n na Square Cloud: package.json com versão fixa, porta 80 e variáveis de URL de webhook, arquivo de configuração e conta de proprietário.
- [Faça deploy da Evolution API (API do WhatsApp)](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-evolution-api.md): Evolution API na Square Cloud: hospede esta API de WhatsApp com PostgreSQL gerenciado, rode as migrações, use a porta 80, chave de API global e cache Redis.
- [Hospede seu próprio Uptime Kuma para monitorar uptime](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-uptime-kuma.md): Uptime Kuma self-hosted na Square Cloud: baixe o project.zip pronto, defina seu subdomínio no arquivo de configuração e faça deploy do seu monitor em minutos.
- [Rode o Selenium com Chromium headless](https://docs.squarecloud.app/pt-br/tutorials/how-to-deploy-your-selenium-application.md): Automação com Selenium na Square Cloud: rode um script Python com Chromium headless e ChromeDriver, as flags que containers exigem, requirements.txt e deploy.
- [Valide dados em Python com Pydantic](https://docs.squarecloud.app/pt-br/tutorials/python/how-to-validate-data-with-pydantic.md): Validação de dados em Python com Pydantic: BaseModel, dataclasses, modo estrito, modelos aninhados, EmailStr e pydantic-settings para validar o ambiente.
- [Corrija NetworkError do python-telegram-bot com aiohttp](https://docs.squarecloud.app/pt-br/tutorials/python/how-to-change-ptb-connection.md): NetworkError no python-telegram-bot: troque o backend httpx padrão pelo aiohttp com o AiohttpRequest do ptbcontrib, com exemplos de Bot e ApplicationBuilder.
- [Migre do Heroku para a Square Cloud](https://docs.squarecloud.app/pt-br/articles/migrating-from-heroku.md): Migre do Heroku para a Square Cloud: mapeie o Procfile, as Config Vars, o Postgres e os logs, faça deploy com a CLI e aponte seu domínio personalizado.
- [Migre do Railway para a Square Cloud](https://docs.squarecloud.app/pt-br/articles/migrating-from-railway.md): Migre do Railway para a Square Cloud: mapeie o railway.json, as variáveis e os plugins de banco de dados, faça deploy com a CLI e passe a um plano mensal fixo.
- [Primeiro deploy com a CLI da Square Cloud](https://docs.squarecloud.app/pt-br/cli-reference/quickstart.md): Instale a CLI da Square Cloud, faça login, faça deploy de um projeto com squarecloud upload, leia os logs e envie cada alteração com squarecloud commit.
- [Como instalar a CLI da Square Cloud](https://docs.squarecloud.app/pt-br/cli-reference/installation.md): Instale a CLI da Square Cloud no macOS, Linux, WSL ou Windows com um único comando, confira se ela funciona, atualize-a e escolha o idioma das mensagens.
- [Login na CLI da Square Cloud](https://docs.squarecloud.app/pt-br/cli-reference/authentication.md): Faça login na CLI da Square Cloud pelo navegador, com uma chave de API ou via SQUARECLOUD_API_KEY no CI, veja a conta atual e renove uma chave expirada.
- [Upload e commit de aplicações pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/deploy.md): Faça deploy de uma pasta como nova aplicação com squarecloud upload, envie alterações com squarecloud commit e confira o conteúdo do zip com squarecloud zip.
- [Deploy pelo GitHub com a CLI](https://docs.squarecloud.app/pt-br/cli-reference/github-deploys.md): Vincule um repositório do GitHub a uma aplicação da Square Cloud com squarecloud app deploy, pelo GitHub App ou por webhook, e liste os deploys de cada push.
- [Gerencie aplicações pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/apps.md): Liste suas aplicações da Square Cloud, veja os detalhes, inicie, pare ou reinicie cada uma e exclua as que você não usa mais com squarecloud app.
- [Leia os logs da aplicação pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/logs.md): Imprima os logs mais recentes de uma aplicação da Square Cloud com squarecloud app logs, ou acompanhe a saída e as mudanças de status ao vivo com app realtime.
- [Status e métricas da aplicação pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/status-and-metrics.md): Veja CPU, memória, disco e uptime de uma ou de todas as aplicações da Square Cloud com squarecloud app status, e as últimas 24 horas com app metrics.
- [Variáveis de ambiente pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/environment-variables.md): Liste, defina, remova ou substitua as variáveis de ambiente de uma aplicação da Square Cloud com squarecloud app env, inclusive a partir de um arquivo .env.
- [Gerencie os arquivos da aplicação pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/files.md): Liste, leia, grave, mova e exclua arquivos de uma aplicação da Square Cloud em execução com squarecloud app file, sem commit. Arquivos binários chegam intactos.
- [Backup e restauração de snapshots pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/snapshots.md): Crie, baixe, liste e restaure snapshots de aplicações e bancos de dados da Square Cloud com squarecloud app snapshot e squarecloud db snapshot.
- [Domínios personalizados pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/domains.md): Conecte um domínio próprio a um site da Square Cloud, veja os registros DNS que você precisa criar e liste todos os domínios e domínios compartilhados da conta.
- [Analytics da edge pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/edge-analytics.md): Veja o tráfego, os erros, os logs de requisições e a latência de um site da Square Cloud na edge com squarecloud app network, e limpe o cache da edge.
- [Gerencie bancos de dados pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/databases.md): Crie, consulte, redimensione, inicie, pare e exclua bancos de dados da Square Cloud com squarecloud db, e imprima ou troque o certificado TLS e a senha.
- [Gerencie workspaces pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/workspaces.md): Crie, consulte, saia e exclua workspaces da Square Cloud com squarecloud workspace, e escolha quais das suas aplicações cada workspace pode ver.
- [Membros do workspace pela CLI](https://docs.squarecloud.app/pt-br/cli-reference/workspace-members.md): Convide pessoas para um workspace da Square Cloud com um código de uso único, mude o grupo de permissão delas e remova-as com squarecloud workspace member.
- [Flags globais, códigos de saída e CI](https://docs.squarecloud.app/pt-br/cli-reference/global-flags-and-ci.md): Use as flags globais da CLI da Square Cloud, a saída em JSON, os códigos de saída e o modo debug, confira a saúde da plataforma e rode a CLI em scripts e CI.
- [Extensão da Square Cloud para VS Code](https://docs.squarecloud.app/pt-br/vscode-extension/installation.md): Instale a extensão da Square Cloud no VS Code ou em editores Open VSX, conecte sua conta com um código no navegador e siga o guia de primeiros passos.
- [Recursos da extensão da Square Cloud para VS Code](https://docs.squarecloud.app/pt-br/vscode-extension/features.md): Faça deploy, gerencie e monitore aplicações, bancos de dados e workspaces pela barra lateral do VS Code, com snapshots, analytics e IntelliSense.
- [Extensão do VS Code: comandos e configurações](https://docs.squarecloud.app/pt-br/vscode-extension/commands.md): Rode qualquer comando da extensão da Square Cloud pela paleta de comandos ou pela barra lateral do VS Code e veja configurações, atualização e soluções comuns.
- [SDKs oficiais para JavaScript, Python e Go](https://docs.squarecloud.app/pt-br/sdks/introduction.md): SDKs oficiais da Square Cloud para JavaScript, Python e Go, além do SDK do Blob Storage: escolha um, instale, defina sua chave de API e faça a primeira chamada.
- [SDK JavaScript: início rápido e cliente](https://docs.squarecloud.app/pt-br/sdks/js/client.md): Instale o SDK JavaScript (@squarecloud/api v6), crie um cliente com sua chave de API e siga as convenções: ids, aplicações de workspace e timeouts.
- [SDK JavaScript: gerenciar aplicações](https://docs.squarecloud.app/pt-br/sdks/js/managing_application.md): Controle suas aplicações com o @squarecloud/api: detalhes, status, iniciar, parar, reiniciar, logs, métricas, domínios, load balancers e exclusão.
- [SDK JavaScript: upload e commit de arquivos](https://docs.squarecloud.app/pt-br/sdks/js/commit_and_upload.md): Crie aplicações a partir de um zip com apps.create() e envie arquivos para uma aplicação existente com apps.commit(), a partir de um caminho, um Blob ou bytes.
- [SDK JavaScript: gerenciador de arquivos da aplicação](https://docs.squarecloud.app/pt-br/sdks/js/managing_files.md): Liste, leia, escreva, mova e exclua os arquivos de uma aplicação com api.apps.files. O conteúdo trafega em base64, então binários chegam intactos.
- [SDK JavaScript: variáveis de ambiente](https://docs.squarecloud.app/pt-br/sdks/js/environment_variables.md): Leia, adicione, substitua e remova as variáveis de ambiente de uma aplicação da Square Cloud com api.apps.envs no SDK JavaScript (@squarecloud/api).
- [SDK JavaScript: deploys pelo GitHub](https://docs.squarecloud.app/pt-br/sdks/js/deploys.md): Faça deploy a partir do GitHub com api.apps.deploys: configure um webhook, vincule um repositório pelo GitHub App da Square Cloud e leia o histórico de deploys.
- [SDK JavaScript: analytics, DNS e domínios](https://docs.squarecloud.app/pt-br/sdks/js/network.md): Leia analytics de borda, erros, logs de requisições e desempenho de uma aplicação web, verifique o DNS, defina um domínio e limpe o cache com api.apps.network.
- [SDK JavaScript: logs e status ao vivo](https://docs.squarecloud.app/pt-br/sdks/js/realtime.md): Acompanhe ao vivo os logs, o status e os eventos de sistema de uma aplicação com api.apps.realtime(), um async iterable que se reconecta sozinho.
- [SDK JavaScript: snapshots e backups](https://docs.squarecloud.app/pt-br/sdks/js/snapshots.md): Liste, crie e restaure snapshots de aplicações e bancos de dados, liste todos os snapshots da conta e baixe um arquivo de snapshot com api.downloadSnapshot().
- [SDK JavaScript: bancos de dados gerenciados](https://docs.squarecloud.app/pt-br/sdks/js/databases.md): Crie, inspecione, atualize, inicie, pare e exclua bancos de dados gerenciados, leia seu status e suas métricas e gerencie suas credenciais com api.databases.
- [SDK JavaScript: workspaces e membros](https://docs.squarecloud.app/pt-br/sdks/js/workspaces.md): Crie e gerencie workspaces, convide membros, defina cargos e compartilhe aplicações com api.workspaces. Atue sobre uma aplicação compartilhada pelo id composto.
- [SDK JavaScript: chat do AI Gateway](https://docs.squarecloud.app/pt-br/sdks/js/ai.md): Chame o AI Gateway da Square Cloud a partir do @squarecloud/api com api.ai.chat(): chat completions compatíveis com OpenAI, sem streaming.
- [SDK JavaScript: erros e novas tentativas](https://docs.squarecloud.app/pt-br/sdks/js/errors.md): Trate o SquareCloudAPIError no @squarecloud/api: status, código e mensagem, os códigos de erro próprios do SDK, novas tentativas, timeouts e rate limits.
- [SDK JavaScript: migrar da v5 para a v6](https://docs.squarecloud.app/pt-br/sdks/js/migrating_to_v6.md): Atualize o @squarecloud/api da v5 para a v6: dados simples em vez de classes, ids como primeiro argumento, uma classe de erro, timeouts e novas tentativas.
- [SDK JavaScript: migrar da v4 para a v5](https://docs.squarecloud.app/pt-br/sdks/js/migrating_to_v5.md): Atualize o @squarecloud/api da v4 para a v5: client.users e backups removidos, novo retorno de apps.create() e novo formato de dns(), com os ajustes mínimos.
- [SDK Python: início rápido e cliente](https://docs.squarecloud.app/pt-br/sdks/py/client.md): Instale o SDK Python (squarecloud-api 5), crie um cliente síncrono ou assíncrono com sua chave de API e siga as convenções: ids, datas e timeouts.
- [SDK Python: gerenciar aplicações](https://docs.squarecloud.app/pt-br/sdks/py/managing_application.md): Controle suas aplicações com o squarecloud-api: detalhes, status, iniciar, parar, reiniciar, logs, métricas, domínios, load balancers e exclusão.
- [SDK Python: upload e commit de arquivos](https://docs.squarecloud.app/pt-br/sdks/py/commit_and_upload.md): Crie aplicações a partir de um zip com apps.create() e envie arquivos para uma aplicação existente com apps.commit(), de um caminho, bytes ou arquivo binário.
- [SDK Python: gerenciador de arquivos da aplicação](https://docs.squarecloud.app/pt-br/sdks/py/managing_files.md): Liste, leia, escreva, mova e exclua os arquivos de uma aplicação com client.apps.files. O conteúdo trafega em base64, então binários chegam intactos.
- [SDK Python: variáveis de ambiente](https://docs.squarecloud.app/pt-br/sdks/py/environment_variables.md): Leia, adicione, substitua e remova as variáveis de ambiente de uma aplicação da Square Cloud com client.apps.envs no SDK Python (squarecloud-api).
- [SDK Python: deploys pelo GitHub](https://docs.squarecloud.app/pt-br/sdks/py/deploys.md): Faça deploy pelo GitHub com client.apps.deploys: configure um webhook, vincule um repositório pelo GitHub App da Square Cloud e leia o histórico de deploys.
- [SDK Python: analytics, DNS e domínios](https://docs.squarecloud.app/pt-br/sdks/py/network.md): Leia analytics de borda, erros, logs de requisições e desempenho de um site, verifique o DNS, defina um domínio e limpe o cache com client.apps.network.
- [SDK Python: logs e status ao vivo](https://docs.squarecloud.app/pt-br/sdks/py/realtime.md): Acompanhe ao vivo os logs, o status e os eventos de uma aplicação com client.apps.realtime() no SDK Python, síncrono ou assíncrono, com reconexão automática.
- [SDK Python: snapshots e backups](https://docs.squarecloud.app/pt-br/sdks/py/snapshots.md): Liste, crie e restaure snapshots de aplicações e bancos de dados, veja todos os snapshots da conta e baixe um snapshot com client.download_snapshot().
- [SDK Python: bancos de dados gerenciados](https://docs.squarecloud.app/pt-br/sdks/py/databases.md): Crie, inspecione, atualize, inicie, pare e exclua bancos de dados gerenciados, leia seu status e suas métricas e gerencie suas credenciais com client.databases.
- [SDK Python: workspaces e membros](https://docs.squarecloud.app/pt-br/sdks/py/workspaces.md): Crie e gerencie workspaces, convide membros, defina cargos e compartilhe aplicações com client.workspaces. Acesse uma aplicação compartilhada pelo id composto.
- [SDK Python: chat do AI Gateway](https://docs.squarecloud.app/pt-br/sdks/py/ai.md): Chame o AI Gateway da Square Cloud a partir do squarecloud-api com client.ai.chat(): chat completions compatíveis com OpenAI, sem streaming.
- [SDK Python: erros e novas tentativas](https://docs.squarecloud.app/pt-br/sdks/py/errors.md): Trate o SquareCloudAPIError no squarecloud-api: status, código e mensagem, os códigos de erro próprios do SDK, novas tentativas, timeouts e rate limits.
- [SDK Python: migrar da v4 para a v5](https://docs.squarecloud.app/pt-br/sdks/py/migrating_to_v5.md): Atualize o squarecloud-api da v4 para a v5: cliente síncrono e assíncrono, dicts simples, métodos por recurso, uma classe de exceção e tabela de métodos.
- [SDK Go: início rápido e cliente](https://docs.squarecloud.app/pt-br/sdks/go/client.md): Instale o SDK Go (sdk-api-go v3), crie um cliente com sua chave de API e siga as convenções: context, ids, aplicações de workspace, datas e timeouts.
- [SDK Go: gerenciar aplicações](https://docs.squarecloud.app/pt-br/sdks/go/managing_application.md): Obtenha, inspecione e controle suas aplicações com o SDK Go: detalhes, status, iniciar, parar, reiniciar, logs, métricas, domínios, load balancers e exclusão.
- [SDK Go: upload e commit de arquivos](https://docs.squarecloud.app/pt-br/sdks/go/commit_and_upload.md): Crie aplicações a partir de um zip com c.Apps.Create e envie arquivos para uma aplicação existente com c.Apps.Commit, em stream de qualquer io.Reader.
- [SDK Go: gerenciador de arquivos da aplicação](https://docs.squarecloud.app/pt-br/sdks/go/managing_files.md): Liste, leia, escreva, mova e exclua os arquivos de uma aplicação com c.Apps.Files. O conteúdo trafega em base64, então texto e binários chegam intactos.
- [SDK Go: variáveis de ambiente](https://docs.squarecloud.app/pt-br/sdks/go/environment_variables.md): Leia, adicione, substitua e remova as variáveis de ambiente de uma aplicação da Square Cloud com c.Apps.Envs no SDK Go, retornadas como um map de strings.
- [SDK Go: deploys pelo GitHub](https://docs.squarecloud.app/pt-br/sdks/go/deploys.md): Faça deploy a partir do GitHub com c.Apps.Deploys: configure um webhook, vincule um repositório pelo GitHub App da Square Cloud e leia o histórico de deploys.
- [SDK Go: analytics, DNS e domínios](https://docs.squarecloud.app/pt-br/sdks/go/network.md): Leia analytics de borda, erros, logs de requisições e desempenho de uma aplicação web, verifique o DNS, defina um domínio e limpe o cache com c.Apps.Network.
- [SDK Go: logs e status ao vivo](https://docs.squarecloud.app/pt-br/sdks/go/realtime.md): Acompanhe ao vivo os logs, o status e os eventos de sistema de uma aplicação com c.Apps.Realtime, um iterador que mescla o status e se reconecta sozinho.
- [SDK Go: snapshots e backups](https://docs.squarecloud.app/pt-br/sdks/go/snapshots.md): Liste, crie e restaure snapshots de aplicações e bancos de dados, liste todos os snapshots da conta e baixe um arquivo de snapshot com c.DownloadSnapshot.
- [SDK Go: bancos de dados gerenciados](https://docs.squarecloud.app/pt-br/sdks/go/databases.md): Crie, inspecione, atualize, inicie, pare e exclua bancos de dados gerenciados, leia seu status e suas métricas e gerencie suas credenciais com c.Databases.
- [SDK Go: workspaces e membros](https://docs.squarecloud.app/pt-br/sdks/go/workspaces.md): Crie e gerencie workspaces, convide membros, defina cargos e compartilhe aplicações com c.Workspaces. Atue sobre uma aplicação compartilhada pelo id composto.
- [SDK Go: chat do AI Gateway](https://docs.squarecloud.app/pt-br/sdks/go/ai.md): Chame o AI Gateway da Square Cloud pelo SDK Go (sdk-api-go) com c.AI.Chat: chat completions compatíveis com OpenAI, sem streaming, direto do seu código Go.
- [SDK Go: erros e novas tentativas](https://docs.squarecloud.app/pt-br/sdks/go/errors.md): Trate o *APIError no SDK Go: status, código e mensagem, errors.As e errors.Is, códigos do SDK, constantes Code, novas tentativas, timeouts e rate limits.
- [SDK Go: migrar da v2 para a v3](https://docs.squarecloud.app/pt-br/sdks/go/migrating_to_v3.md): Atualize o SDK Go da Square Cloud da v2 para a v3: um único pacote, um *Client concreto, ctx primeiro, grupos de recursos, um tipo de erro e tabela de métodos.
- [SDK Blob: instalar e criar o cliente](https://docs.squarecloud.app/pt-br/sdks/blob/client.md): Instale o @squarecloud/blob e crie um cliente SquareCloudBlob com uma chave de API ou um token de upload. A única opção é maxRetries.
- [SDK Blob: uploads e tokens de upload](https://docs.squarecloud.app/pt-br/sdks/blob/uploads.md): Envie arquivos com put(): caminhos, Blob/File ou bytes, upload multipart automático acima de 90 MiB e tokens para enviar direto do navegador.
- [SDK Blob: gerenciar objetos e links](https://docs.squarecloud.app/pt-br/sdks/blob/objects.md): Liste, inspecione, atualize, exclua, copie e mova objetos do Blob Storage com o SDK @squarecloud/blob, e gere links de download permanentes ou temporários.
- [SDK Blob: links de compartilhamento](https://docs.squarecloud.app/pt-br/sdks/blob/sharing.md): Crie, liste e revogue links de compartilhamento do Blob Storage no @squarecloud/blob, com expiração, limite de downloads e senha, e compare com downloadUrl().
- [SDK Blob: regras por prefixo e estatísticas de uso](https://docs.squarecloud.app/pt-br/sdks/blob/rules_and_stats.md): Leia e substitua regras por prefixo com o @squarecloud/blob (visibilidade, expiração, tamanho, extensões, exclusão automática) e veja o uso do Blob Storage.
- [SDK Blob: cliente do gateway S3](https://docs.squarecloud.app/pt-br/sdks/blob/s3.md): Obtenha credenciais S3 com s3Credentials() e um S3Client pronto para uso com s3() para acessar o Blob Storage pelo gateway compatível com S3.
- [SDK Blob: erros e novas tentativas](https://docs.squarecloud.app/pt-br/sdks/blob/errors.md): SquareCloudBlobError, a lista de BlobErrorCode, os erros de rede que não são encapsulados e exatamente quais chamadas o @squarecloud/blob tenta novamente.
- [SDK Blob: migrar da v3 para a v4](https://docs.squarecloud.app/pt-br/sdks/blob/migrating_to_v4.md): O que mudou no @squarecloud/blob 4.0.0: novas tentativas mais seguras e em menor número, SavedRule.active_from opcional e exclusão em lote com um único id.
- [API da Square Cloud: URL base e primeira requisição](https://docs.squarecloud.app/pt-br/api-reference/introduction.md): Comece pela API REST da Square Cloud: a URL base da v2, o header Authorization, uma primeira requisição com curl, o formato das respostas, IDs e escopos.
- [Autenticação, chaves e escopos da API](https://docs.squarecloud.app/pt-br/api-reference/authentication.md): Autentique-se na API da Square Cloud com uma chave de API no header Authorization, escolha os escopos de cada endpoint e restrinja a chave a recursos.
- [Códigos de erro da API e como resolver](https://docs.squarecloud.app/pt-br/api-reference/errors.md): Todos os códigos de erro da API da Square Cloud por área, com o status HTTP, o que cada um significa e o que fazer, além das regras para novas tentativas.
- [Limites de requisições da API e restrições regionais](https://docs.squarecloud.app/pt-br/api-reference/limitations-and-restrictions.md): Limites de requisições por plano da API da Square Cloud, os países bloqueados por sanções ou regulações e os países que precisam resolver um captcha antes.
- [Especificação OpenAPI da API REST](https://docs.squarecloud.app/pt-br/api-reference/openapi.md): Obtenha a especificação OpenAPI da API da Square Cloud, legível por máquinas, em GET /v2/openapi.json para gerar clientes ou importar no Postman ou no Insomnia.
- [Obter informações da conta](https://docs.squarecloud.app/pt-br/api-reference/endpoint/users/me.md): Obtenha sua conta em uma chamada com GET /v2/users/me: perfil, plano, uso de memória e todas as suas aplicações e bancos de dados, pronta para uma visão geral.
- [Listar todos os snapshots da conta](https://docs.squarecloud.app/pt-br/api-reference/endpoint/users/snapshots.md): Liste os snapshots automáticos das suas aplicações ou bancos de dados com GET /v2/users/snapshots, com tamanho, data e URL de download. Exige plano ativo.
- [Listar todos os domínios](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/domains.md): Liste todos os hostnames com GET /v2/apps/domains: domínios personalizados primeiro, depois os subdomínios squareweb.app, cada um com sua aplicação.
- [Listar balanceadores de carga](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/load-balancers.md): Liste os domínios personalizados da conta e as aplicações de cada um com GET /v2/apps/load-balancers, além do limite de aplicações por domínio do plano.
- [Obter status do serviço](https://docs.squarecloud.app/pt-br/api-reference/endpoint/service/status.md): Verifique a saúde geral da plataforma Square Cloud com GET /v2/service/status. É público, não exige chave de API e é servido de um cache de 5 minutos.
- [Enviar aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/upload.md): Crie e faça deploy de uma nova aplicação a partir de um .zip de até 100 MB com POST /v2/apps. A runtime é detectada sozinha; use o commit nas próximas mudanças.
- [Status de todas as aplicações](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/status-all.md): Obtenha CPU, RAM e estado de execução ao vivo de todas as suas aplicações com GET /v2/apps/status. Passe workspaceId para listar as aplicações de um workspace.
- [Consultar informações da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/info.md): Obtenha os metadados de uma aplicação com GET /v2/apps/{app_id}: nome, dono, cluster, RAM alocada, linguagem e domínio. Vale para aplicações de workspace.
- [Obter status da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/status.md): Obtenha CPU, RAM, armazenamento, rede e uptime ao vivo de uma aplicação com GET /v2/apps/{app_id}/status. Passe rawData=true para números em vez de strings.
- [Obter logs](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/logs.md): Obtenha um retrato do stdout e do stderr recentes de uma aplicação com GET /v2/apps/{app_id}/logs. Para logs ao vivo, use o stream SSE em tempo real.
- [Logs e métricas em tempo real (SSE)](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/realtime.md): Abra um stream Server-Sent Events com GET /v2/apps/{app_id}/realtime para logs, métricas, status e progresso de deploy ao vivo. A conexão dura até 10 minutos.
- [Obter métricas da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/metrics.md): Obtenha o histórico de CPU, RAM e rede de uma aplicação com GET /v2/apps/{app_id}/metrics: até 288 pontos nas últimas 24 horas, um a cada 5 minutos.
- [Iniciar aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/start.md): Inicie uma aplicação parada com POST /v2/apps/{app_id}/start. Retorna 409 quando ela já está em execução, e nunca faz deploy de código novo.
- [Reiniciar aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/restart.md): Reinicie uma aplicação com POST /v2/apps/{app_id}/restart, parando e iniciando de novo. Use depois de um commit para os novos arquivos entrarem em vigor.
- [Parar aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/stop.md): Pare uma aplicação em execução com POST /v2/apps/{app_id}/stop, mantendo arquivos, variáveis e configuração. Retorna 409 quando ela já está parada.
- [Fazer commit de arquivos na aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/commit.md): Envie um arquivo ou um .zip para uma aplicação existente com POST /v2/apps/{app_id}/commit. Arquivos de até 100 MB, e a aplicação não reinicia sozinha.
- [Excluir aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/delete.md): Exclua uma aplicação de vez com DELETE /v2/apps/{app_id}. Libera o domínio personalizado, não pode ser desfeito e é recusado durante uma restauração.
- [Listar variáveis de ambiente](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/envs/get.md): Leia as variáveis de ambiente de uma aplicação como um objeto chave-valor com GET /v2/apps/{app_id}/envs. Retorna um objeto vazio quando não há nenhuma.
- [Adicionar ou editar variáveis de ambiente](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/envs/add_n_edit.md): Adicione ou atualize variáveis de ambiente com POST /v2/apps/{app_id}/envs. As que ficam fora do corpo não mudam, o que serve para trocar uma única chave.
- [Substituir todas as variáveis de ambiente](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/envs/overwrite.md): Substitua todo o ambiente de uma aplicação com PUT /v2/apps/{app_id}/envs: variáveis fora do corpo são excluídas, e um objeto envs vazio apaga todas.
- [Remover variáveis de ambiente](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/envs/remove.md): Exclua uma ou mais variáveis de ambiente pela chave com DELETE /v2/apps/{app_id}/envs. Chaves inexistentes são ignoradas e as restantes são retornadas.
- [Listar arquivos da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/filemanager/list.md): Liste os arquivos e diretórios de um caminho da aplicação com GET /v2/apps/{app_id}/files, cada um com tipo, tamanho e data da última modificação.
- [Ler um arquivo da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/filemanager/content.md): Leia um arquivo de até 10 MB de uma aplicação com GET /v2/apps/{app_id}/files/content. Envie encoding=base64, já que o formato Buffer foi descontinuado.
- [Criar ou atualizar um arquivo da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/filemanager/put.md): Crie ou sobrescreva um arquivo de uma aplicação com PUT /v2/apps/{app_id}/files. Envie conteúdo em base64 para binários, até 10 MB cada, sem reinício.
- [Mover ou renomear um arquivo da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/filemanager/patch.md): Mova ou renomeie um arquivo dentro de uma aplicação com PATCH /v2/apps/{app_id}/files, de path para to, sem enviá-lo de novo nem reiniciar a aplicação.
- [Excluir um arquivo da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/filemanager/delete.md): Exclua um único arquivo de uma aplicação pelo caminho com DELETE /v2/apps/{app_id}/files. Vale na hora, sem reiniciar a aplicação nem fazer um novo deploy.
- [Listar deploys](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/deploy/list.md): Liste os deploys recentes via Git de uma aplicação com GET /v2/apps/{app_id}/deployments, com cada estado, de pending a success, ou o código de erro.
- [Obter o deploy atual](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/deploy/info.md): Veja como uma aplicação faz deploy via Git com GET /v2/apps/{app_id}/deployments/current: repositório do GitHub App, webhook legado ou os dois.
- [Configurar webhook do GitHub](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/deploy/webhooks.md): Conecte uma aplicação a um repositório do GitHub com um token de acesso pessoal via POST /v2/apps/{app_id}/deploy/webhook, ou envie @ para remover o webhook.
- [Vincular repositório do GitHub App](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/deploy/github-app-link.md): Vincule um repositório e uma branch do GitHub a uma aplicação com POST /v2/apps/{app_id}/deploy/github-app, para cada push nessa branch fazer deploy.
- [Desvincular repositório do GitHub App](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/deploy/github-app-unlink.md): Desvincule o repositório do GitHub App com DELETE /v2/apps/{app_id}/deploy/github-app. Os pushes deixam de fazer deploy e o código em execução segue igual.
- [Configurar domínio personalizado](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/custom.md): Vincule um domínio personalizado a uma aplicação com POST /v2/apps/{app_id}/network/custom, ou envie @ para removê-lo. Disponível no Standard, Pro e Enterprise.
- [Obter registros DNS do domínio personalizado](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/dns.md): Obtenha os registros TXT e CNAME de que um domínio personalizado precisa para validação e SSL com GET /v2/apps/{app_id}/network/dns, para criar no registrador.
- [Obter analytics de tráfego do site](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/analytics.md): Obtenha analytics de tráfego na borda dos domínios de uma aplicação com GET /v2/apps/{app_id}/network/analytics: requisições, banda, visitantes e detalhes.
- [Obter logs de requisições na borda](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/logs.md): Obtenha logs de borda por requisição dos domínios de uma aplicação com GET /v2/apps/{app_id}/network/logs, de até 7 dias atrás. Disponível no Pro e Enterprise.
- [Obter detalhamento de erros na borda](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/errors.md): Conte os erros na borda por status, caminho, método e horário com GET /v2/apps/{app_id}/network/errors. Só 5xx por padrão; include_4xx=true soma os 4xx.
- [Obter latência de borda e de origem](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/performance.md): Obtenha percentis de latência de borda e de origem com GET /v2/apps/{app_id}/network/performance, por país, colo e caminho mais lento. Para Pro e Enterprise.
- [Limpar o cache de borda da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/network/purge_cache.md): Limpe todas as respostas em cache na borda dos domínios de uma aplicação com POST /v2/apps/{app_id}/network/purge_cache, e a próxima requisição vem atualizada.
- [Listar snapshots da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/snapshots/list.md): Liste os snapshots salvos de uma aplicação com GET /v2/apps/{app_id}/snapshots, cada um com tamanho, data, URL de download e os IDs para restaurá-lo.
- [Criar snapshot da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/snapshots/create.md): Faça backup dos arquivos da aplicação em .zip com POST /v2/apps/{app_id}/snapshots. Retorna uma URL de download, ou 202 enquanto um snapshot grande é gerado.
- [Restaurar snapshot da aplicação](https://docs.squarecloud.app/pt-br/api-reference/endpoint/apps/snapshots/restore.md): Volte os arquivos de uma aplicação para um snapshot com POST /v2/apps/{app_id}/snapshots/restore, usando o snapshotId e o versionId da listagem.
- [Criar banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/create.md): Crie um banco MongoDB, MySQL, PostgreSQL ou Redis gerenciado com POST /v2/databases. A senha e o certificado são retornados uma única vez, então guarde-os.
- [Status de todos os bancos de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/status-all.md): Obtenha CPU, RAM e estado de execução ao vivo de todos os seus bancos de dados em uma chamada com GET /v2/databases/status, em vez de uma requisição por banco.
- [Consultar informações do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/info.md): Obtenha os metadados de um banco de dados com GET /v2/databases/{database_id}: nome, dono, cluster, RAM alocada, engine e porta, sem o uso ao vivo.
- [Obter status do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/status.md): Obtenha CPU, RAM, rede, armazenamento e uptime ao vivo de um banco de dados com GET /v2/databases/{database_id}/status. Passe rawData=true para números.
- [Obter métricas do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/metrics.md): Obtenha o histórico de CPU, RAM e rede de um banco de dados com GET /v2/databases/{database_id}/metrics: até 288 pontos em 24 horas, um a cada 5 minutos.
- [Iniciar banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/start.md): Inicie um banco de dados parado com POST /v2/databases/{database_id}/start. Ele volta com a mesma URL de conexão, porta e credenciais de antes.
- [Parar banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/stop.md): Pare um banco de dados em execução com POST /v2/databases/{database_id}/stop. Os dados são mantidos, e ele volta com as mesmas credenciais e URL de conexão.
- [Editar banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/edit.md): Renomeie um banco de dados ou altere sua memória com PATCH /v2/databases/{database_id}, sem reiniciá-lo nem mudar as credenciais e a URL de conexão.
- [Excluir banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/delete.md): Exclua um banco de dados de vez e libere seu registro DNS com DELETE /v2/databases/{database_id}. Não há confirmação, então faça um snapshot antes.
- [Obter certificado TLS do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/credentials/get_certificate.md): Obtenha o arquivo TLS de um banco de dados com GET /v2/databases/{database_id}/credentials/certificate: um PEM em base64 com a chave privada e o certificado.
- [Redefinir senha ou certificado do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/credentials/reset.md): Troque a senha ou o certificado TLS de um banco de dados com POST /v2/databases/{database_id}/credentials/reset. A nova senha é exibida uma única vez.
- [Listar snapshots do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/snapshots/list.md): Liste os snapshots de um banco de dados, do mais novo ao mais antigo, com GET /v2/databases/{database_id}/snapshots: tamanho, data, URL e IDs para restaurar.
- [Criar snapshot do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/snapshots/create.md): Faça backup dos dados de um banco com POST /v2/databases/{database_id}/snapshots. Retorna uma URL de download válida por 1 hora, ou 202 enquanto é gerado.
- [Restaurar snapshot do banco de dados](https://docs.squarecloud.app/pt-br/api-reference/endpoint/databases/snapshots/restore.md): Sobrescreva os dados de um banco com um snapshot usando POST /v2/databases/{database_id}/snapshots/restore. A engine do snapshot precisa ser a mesma do banco.
- [Listar workspaces](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/list.md): Liste os workspaces que você tem ou dos quais participa com GET /v2/workspaces, cada um com membros, cargos e aplicações compartilhadas. Vazio se não houver.
- [Obter workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/get.md): Obtenha um workspace com GET /v2/workspaces/{workspaceId}: dono, membros e cargos, aplicações compartilhadas e data de criação. Quem não é membro recebe 404.
- [Criar workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/create.md): Crie um workspace com POST /v2/workspaces para compartilhar aplicações com outras contas da Square Cloud por função. Disponível no Standard, Pro e Enterprise.
- [Excluir workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/delete.md): Exclua um workspace e sua lista de membros com DELETE /v2/workspaces. Só o dono pode fazer isso, e as aplicações compartilhadas seguem rodando com o dono.
- [Sair do workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/leave.md): Saia de um workspace do qual você é membro com DELETE /v2/workspaces/leave e perca na hora o acesso às aplicações compartilhadas. O dono exclui em vez de sair.
- [Obter código de convite do workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/members/code.md): Gere um código de convite de uso único com GET /v2/workspaces/members/code e passe ao dono de um workspace, que adiciona você com ele. Expira em 5 minutos.
- [Convidar membro para o workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/members/invite.md): Adicione um membro a um workspace com POST /v2/workspaces/members usando o código de convite dele e uma função: view, manager, maintain ou admin. Só o dono.
- [Alterar a função de um membro do workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/members/perms.md): Altere a função de um membro do workspace com PATCH /v2/workspaces/members para view, manager, maintain ou admin. Vale na hora; só o dono pode fazer isso.
- [Remover membro do workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/members/kick.md): Remova um membro de um workspace com DELETE /v2/workspaces/members, revogando na hora o acesso dele a todas as aplicações compartilhadas. Só o dono pode.
- [Compartilhar aplicação com um workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/apps/add.md): Compartilhe uma aplicação sua com um workspace seu via POST /v2/workspaces/applications, e os membros ganham acesso por função, sem transferência.
- [Remover aplicação de um workspace](https://docs.squarecloud.app/pt-br/api-reference/endpoint/workspace/apps/remove.md): Pare de compartilhar uma aplicação com um workspace via DELETE /v2/workspaces/applications. Os membros perdem o acesso e a aplicação segue rodando com o dono.
- [AI Gateway compatível com OpenAI (beta)](https://docs.squarecloud.app/pt-br/api-reference/ai-gateway.md): Use o modelo cubic da Square Cloud nos seus próprios produtos pelo POST /v2/ai/chat/completions, compatível com OpenAI, com tool calling e busca na web.
- [Guia rápido da API do Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/quickstart.md): Envie e baixe o seu primeiro arquivo com a API do Blob Storage: a URL base da v1, o header Authorization, um upload com curl, a resposta e um link de download.
- [Autenticação na API do Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/authentication.md): Autentique-se na API do Blob Storage com uma chave de API ou um token de upload de curta duração no header Authorization, e escolha os escopos de cada rota.
- [Códigos de erro da API do Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/errors.md): Todos os códigos de erro que a API do Blob Storage retorna, com status HTTP e o que fazer, e quando tentar de novo com backoff ou corrigir a requisição.
- [Compatibilidade do Blob Storage com S3](https://docs.squarecloud.app/pt-br/blob-reference/s3-compatibility.md): Use aws-cli, boto3, rclone e os AWS SDKs com o Blob Storage pelo gateway compatível com S3: endpoint, buckets, operações suportadas e limites.
- [Links e compartilhamento no Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/links-and-sharing.md): URLs públicas, links temporários e de compartilhamento no Blob Storage: quando usar cada um, quanto duram e o que muda quando o arquivo troca de visibilidade.
- [Enviar um arquivo para o Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/post.md): Envie um arquivo de até 100 MB para o Blob Storage com POST /v1/objects: público ou privado, com opções de expiração, cache, metadados e checksum.
- [Listar arquivos do Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/list.md): Liste os arquivos do seu Blob Storage com GET /v1/objects: filtre por prefixo e visibilidade, navegue por pastas e pagine com um cursor.
- [Obter detalhes de um arquivo](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/info.md): Leia os detalhes de um arquivo com GET /v1/objects/info: tamanho, content type, expiração, visibilidade, cache, nome original e metadados.
- [Atualizar opções de arquivos](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/update.md): Altere a visibilidade, a expiração, o cache, a disposition ou os metadados de até 50 arquivos por requisição com PATCH /v1/objects, sem enviá-los de novo.
- [Copiar, mover ou renomear um arquivo](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/copy.md): Copie, mova ou renomeie um arquivo dentro do Blob Storage com POST /v1/objects/copy, no servidor e sem baixá-lo. Com move: true, a origem é removida.
- [Excluir arquivos do Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/delete.md): Exclua um arquivo ou até 100 arquivos por requisição do Blob Storage com DELETE /v1/objects, com resultados por arquivo nos lotes.
- [Criar um link de download temporário](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/download.md): Obtenha um link de download para qualquer arquivo com GET /v1/objects/download: um link temporário de até 24 horas para arquivos privados, ou a URL pública.
- [Iniciar um upload em partes](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/chunked-init.md): Abra um upload em partes para arquivos de até 10 GiB com POST /v1/objects/chunked e obtenha o token de upload para as próximas chamadas.
- [Enviar uma parte do upload em partes](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/chunked-part.md): Envie uma parte de um upload em partes com PUT /v1/objects/chunked: bytes brutos, de 5 a 32 MB cada exceto a última, em qualquer ordem e com reenvio seguro.
- [Obter status de um upload em partes](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/chunked-status.md): Veja quais partes de um upload em partes já chegaram com GET /v1/objects/chunked, para retomar um upload interrompido enviando só as partes que faltam.
- [Concluir um upload em partes](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/chunked-complete.md): Finalize um upload em partes com PATCH /v1/objects/chunked: o servidor junta as partes recebidas no arquivo final, que passa a contar na sua cota.
- [Cancelar um upload em partes](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/chunked-abort.md): Cancele um upload em partes e descarte as partes com DELETE /v1/objects/chunked. É idempotente e não exige plano ativo, então você sempre consegue limpar.
- [Listar uploads em partes abertos](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/chunked-open.md): Liste os uploads em partes abertos da conta com GET /v1/objects/chunked/open, inclusive os iniciados pelo S3, com um token para retomar ou cancelar cada um.
- [Consultar o uso do Blob Storage](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/stats.md): Consulte o uso do Blob Storage com GET /v1/account/stats: arquivos, bytes, armazenamento incluído, a média do mês e a estimativa do que passar da cota.
- [Obter regras por prefixo](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/settings-get.md): Leia as regras por prefixo da sua conta do Blob Storage com GET /v1/account/settings: visibilidade, expiração e cache padrão, limites e exclusão automática.
- [Definir regras por prefixo](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/settings-put.md): Defina regras por prefixo com PUT /v1/account/settings: visibilidade, expiração e cache padrão, limites de tamanho e de tipo, e exclusão automática após N dias.
- [Criar um token de upload](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/upload-tokens.md): Gere um token de upload de curta duração com POST /v1/upload-tokens para que um navegador faça upload direto para o Blob Storage sem a sua chave de API.
- [Criar um link de compartilhamento](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/shares-create.md): Crie um link de compartilhamento com POST /v1/shares: válido por até 30 dias, revogável, com limite opcional de downloads e, no Pro e no Enterprise, senha.
- [Listar links de compartilhamento](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/shares-list.md): Liste os links de compartilhamento ativos da sua conta com GET /v1/shares, com expiração, downloads restantes e status da senha de cada link ainda válido.
- [Revogar um link de compartilhamento](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/shares-delete.md): Revogue um link de compartilhamento do Blob Storage com DELETE /v1/shares usando o id do share. O link passa a responder 404, e o arquivo continua armazenado.
- [Obter credenciais S3](https://docs.squarecloud.app/pt-br/blob-reference/endpoint/s3-credentials.md): Obtenha o par de chaves de acesso S3 da sua chave de API com GET /v1/s3/credentials, para usar aws-cli, boto3, rclone e os AWS SDKs com o Blob Storage.

## Optional

- [Dashboard](https://squarecloud.app/en/dashboard)
- [Pricing](https://squarecloud.app/en/pricing)
- [Support](https://squarecloud.app/en/support)
- [Discord community](https://go.squarecloud.app/discord)