> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dscloud.pt/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão geral da API

> Use a API REST v3 da DSCloud para consultar sua conta, operar aplicações e gerenciar bancos MySQL.

A API v3 usa JSON nas respostas e recebe uma chave de API no cabeçalho HTTP `Authorization`. O endereço configurado na CLI e nos SDKs é `https://api.dscloud.pt/v3`.

> [!WARNING]
>
> Se `api.dscloud.pt` retornar uma página da Cloudflare com erro 1000, a requisição não chegou à API v3. Procure o [suporte da DS Cloud](https://docs.dscloud.pt/corporation/support.md). Se a equipe fornecer outro endereço HTTPS, configure `DSCLOUD_API_BASE_URL` com o sufixo `/v3` antes de enviar a chave.

> [card] [Autenticação](https://docs.dscloud.pt/api-reference/authentication.md)
>
> Obtenha a chave e proteja o acesso à sua conta.

> [card] [Erros e limites](https://docs.dscloud.pt/api-reference/restrictions.md)
>
> Trate falhas, limites de requisições e restrições de upload.

## Faça a primeira consulta

Defina `DSCLOUD_API_KEY` no seu ambiente e abra [Consultar a conta](https://docs.dscloud.pt/api-reference/endpoint/users/me.md) para copiar um exemplo em cURL, JavaScript ou Python. A resposta inclui o ID de cada aplicação.

## Recursos da API

| Categoria | Operações |
| - | - |
| Conta | [Perfil e aplicações](https://docs.dscloud.pt/api-reference/endpoint/users/me.md). |
| Aplicações | [Upload](https://docs.dscloud.pt/api-reference/endpoint/apps/upload.md), [estado](https://docs.dscloud.pt/api-reference/endpoint/apps/status-all.md), logs e ciclo de vida. |
| Arquivos e backups | [Listagem de arquivos](https://docs.dscloud.pt/api-reference/endpoint/apps/filemanager/list.md), leitura, gravação, movimentação e [backups](https://docs.dscloud.pt/api-reference/endpoint/apps/backups/get.md). |
| Deploys | [Commit](https://docs.dscloud.pt/api-reference/endpoint/apps/commit.md), [histórico](https://docs.dscloud.pt/api-reference/endpoint/apps/deploy/list.md) e integração por webhook. |
| Bancos de dados | [MySQL](https://docs.dscloud.pt/database-reference/introduction.md), criação, listagem, rotação de senha e exclusão. |

Para automação do painel, use esta API com a chave da conta. As chamadas que o painel faz com uma sessão do navegador pertencem a outro serviço.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.