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

# Parar banco de dados

> 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.

<ParamField header="Authorization" type="string" placeholder="Chave da API" required>
  A chave da API para sua conta. Você pode encontrá-la nas [configurações da conta](https://squarecloud.app/pt-br/account/security).
</ParamField>

Requer uma chave de API com o [escopo](/pt-br/api-reference/authentication#escopos) `databases:write`.

Para um container de banco de dados em execução. O volume de dados é preservado, então uma chamada subsequente de [Iniciar Banco de Dados](/pt-br/api-reference/endpoint/databases/start) o traz de volta com as mesmas credenciais, porta e URL de conexão. Use isso para pausar o uso relevante para faturamento ou tirar um banco de dados do ar antes de uma manutenção.

A requisição é rejeitada enquanto uma restauração de snapshot está em andamento no mesmo banco de dados. Limite de taxa de 1 parada a cada 3 segundos por usuário. Para verificar se a parada realmente teve efeito, consulte [Obter Status do Banco de Dados](/pt-br/api-reference/endpoint/databases/status).

## Parâmetros

<ParamField path="database_id" type="string" placeholder="ID do banco de dados" required>
  O ID do banco de dados.
</ParamField>

## Resposta

<ResponseField name="status" type="string">
  Indica se a chamada foi bem-sucedida: `success` se foi, `error` se não.
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
    "status":"success"
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `RESTORE_IN_PROGRESS` | 403 | Uma restauração de snapshot está em andamento para este banco de dados; aguarde até terminar. |
| `DATABASE_NOT_FOUND` | 404 | O banco de dados não existe ou não pertence a quem fez a chamada. |
| `CONTAINER_ALREADY_STOPPED` | 409 | O banco de dados já está parado. |
| `CONTAINER_TEMPORARILY_SUSPENDED` | 409 | O banco de dados está suspenso temporariamente. |
| `ACTION_FAILED` | 409 | O cluster rejeitou a ação por outro motivo. |

## Relacionados

* CLI: [`squarecloud db stop`](/pt-br/cli-reference/databases#squarecloud-db-stop)
* SDKs: [`api.databases.stop()`](/pt-br/sdks/js/databases) (JavaScript), [`client.databases.stop()`](/pt-br/sdks/py/databases) (Python), [`c.Databases.Stop()`](/pt-br/sdks/go/databases) (Go)


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