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

# Fazer backup

> Pede uma cópia dos arquivos do projeto agora.

O backup entra na fila e fica `ready` em alguns segundos. Consulte [Listar backups](/api-reference/backups/list) até ele sair de `pending`/`creating`. Quando o histórico está cheio, o backup mais antigo sai assim que o novo fica pronto.


## OpenAPI

````yaml POST /projects/{id}/backups
openapi: 3.1.0
info:
  title: API da Cube Hosting
  version: 1.0.0
  description: >-
    Hospede bots de Discord, sites e APIs em Node.js e Python: envie o .zip,
    inicie, pare, reinicie, leia logs e métricas, cuide das variáveis de
    ambiente e faça e baixe backups.
  contact:
    name: Cube Hosting
    url: https://discord.gg/pv6D9tUsDV
servers:
  - url: https://app.cubehosting.com.br/api
security:
  - bearerAuth: []
tags:
  - name: Projetos
  - name: Controle
  - name: Logs e métricas
  - name: Variáveis de ambiente
  - name: Backups
paths:
  /projects/{id}/backups:
    post:
      tags:
        - Backups
      summary: Fazer backup
      description: >-
        Pede um backup dos arquivos do projeto agora, em todos os planos. A
        resposta chega na hora com o backup em `pending`; ele fica `ready` em
        alguns segundos (acompanhe por [Listar
        backups](/api-reference/backups/list)). As dependências (`node_modules`,
        `venv`) não entram. Um backup por vez em cada projeto.
      operationId: createBackup
      parameters:
        - $ref: '#/components/parameters/ProjectId'
      responses:
        '202':
          description: Pedido aceito; o backup entra na fila.
          content:
            application/json:
              schema:
                type: object
                required:
                  - backup
                properties:
                  backup:
                    $ref: '#/components/schemas/Backup'
              example:
                backup:
                  id: 5b0c7a4e-2f1d-4c8e-9a36-7d2b1e0f4c11
                  type: manual
                  status: pending
                  sizeBytes: null
                  error: null
                  createdAt: '2026-09-27T18:00:00.000Z'
                  finishedAt: null
                  expiresAt: '2026-10-27T18:00:00.000Z'
        '401':
          description: Chave ausente, inválida ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_api_key:
                  summary: invalid_api_key
                  value:
                    status: error
                    code: invalid_api_key
                    message: >-
                      Chave de API inválida ou revogada. Confira o cabeçalho
                      "Authorization: Bearer <chave>" ou crie outra em Chaves de
                      API no painel.
        '403':
          description: A chave é só de leitura.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                insufficient_permission:
                  summary: insufficient_permission
                  value:
                    status: error
                    code: insufficient_permission
                    message: >-
                      Esta chave é só de leitura. Para enviar, iniciar, parar,
                      reiniciar, mexer nas variáveis ou fazer e baixar backups,
                      crie uma chave de leitura e escrita no painel.
        '404':
          description: O projeto não existe ou não é da sua conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  summary: not_found
                  value:
                    status: error
                    code: not_found
                    message: Projeto não encontrado.
        '409':
          description: >-
            Já tem um backup em andamento, o projeto ainda está sendo criado, ou
            a conta está suspensa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                backup_in_progress:
                  summary: backup_in_progress
                  value:
                    status: error
                    code: backup_in_progress
                    message: >-
                      Este projeto já tem um backup em andamento. Espere
                      terminar para pedir outro.
                project_busy:
                  summary: project_busy
                  value:
                    status: error
                    code: project_busy
                    message: >-
                      O projeto está sendo preparado ou já tem outra ação em
                      andamento. Espere terminar.
                account_suspended:
                  summary: account_suspended
                  value:
                    status: error
                    code: account_suspended
                    message: >-
                      Sua conta está suspensa porque o Pix da renovação não foi
                      pago, então os projetos ficam parados. Pague em Plano e
                      cobrança: a conta volta na hora, e o que estava no ar sobe
                      sozinho.
                beta_ending:
                  summary: beta_ending
                  value:
                    status: error
                    code: beta_ending
                    message: >-
                      Seu beta terminou e a conta está voltando ao plano Free.
                      Espere alguns minutos e tente de novo.
        '429':
          description: Limite de pedidos. Traz o cabeçalho `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limit_exceeded:
                  summary: rate_limit_exceeded
                  value:
                    status: error
                    code: rate_limit_exceeded
                    message: >-
                      A sua conta passou do limite da API do plano Free: 10
                      pedidos por minuto. Espere 42 s e tente de novo.
                too_many_attempts:
                  summary: too_many_attempts
                  value:
                    status: error
                    code: too_many_attempts
                    message: Muitas tentativas. Tente de novo em 15 minutos.
        '503':
          description: O armazenamento dos backups não respondeu. Nada foi feito.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                backups_unavailable:
                  summary: backups_unavailable
                  value:
                    status: error
                    code: backups_unavailable
                    message: >-
                      Os backups não estão disponíveis agora. Tente de novo em
                      instantes.
      x-codeSamples:
        - lang: bash
          label: curl
          source: >-
            curl -X POST
            https://app.cubehosting.com.br/api/projects/$PROJECT_ID/backups \
              -H "Authorization: Bearer $CUBE_API_KEY"
        - lang: javascript
          label: Node.js
          source: >-
            const API = 'https://app.cubehosting.com.br/api';

            const headers = { Authorization: `Bearer
            ${process.env.CUBE_API_KEY}` };


            const res = await
            fetch(`${API}/projects/${process.env.PROJECT_ID}/backups`, {
              method: 'POST',
              headers,
            });

            const { backup } = await res.json();

            console.log(backup.id, backup.status); // pending
        - lang: python
          label: Python
          source: >-
            import os

            import requests


            API = "https://app.cubehosting.com.br/api"

            headers = {"Authorization": f"Bearer {os.environ['CUBE_API_KEY']}"}


            r =
            requests.post(f"{API}/projects/{os.environ['PROJECT_ID']}/backups",
            headers=headers, timeout=30)

            r.raise_for_status()

            print(r.json()["backup"]["id"])
components:
  parameters:
    ProjectId:
      name: id
      in: path
      required: true
      description: >-
        O ID do projeto (26 caracteres). Aparece no painel, no topo do projeto,
        e em `GET /projects`.
      schema:
        type: string
        pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
        example: 01J8Z3W6N0Q4Y7V2K5T9D1H3XA
  schemas:
    Backup:
      type: object
      description: Uma cópia dos arquivos do projeto (sem as dependências).
      required:
        - id
        - type
        - status
        - sizeBytes
        - error
        - createdAt
        - finishedAt
        - expiresAt
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - manual
            - daily
            - before_suspension
            - before_deletion
          description: >-
            `manual` (Fazer backup agora ou a API), `daily` (o automático dos
            planos pagos), `before_suspension` (a cópia feita quando a conta é
            suspensa), `before_deletion` (a cópia antes de apagar um projeto
            parado).
        status:
          type: string
          enum:
            - pending
            - creating
            - ready
            - failed
          description: >-
            `pending` (na fila), `creating` (sendo feito), `ready` (pronto para
            baixar e restaurar), `failed` (não deu certo; o motivo vem em
            `error`).
        sizeBytes:
          type:
            - integer
            - 'null'
          description: Tamanho do `.zip`, em bytes. `null` até ficar pronto.
        error:
          oneOf:
            - $ref: '#/components/schemas/BackupError'
            - type: 'null'
          description: O motivo, quando `status` é `failed`.
        createdAt:
          type: string
          format: date-time
        finishedAt:
          type:
            - string
            - 'null'
          format: date-time
        expiresAt:
          type: string
          format: date-time
          description: >-
            Até quando o backup fica guardado (30 dias). Pode sair antes, quando
            o histórico passa do limite do plano.
    Error:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: string
          const: error
        code:
          type: string
          description: Código fixo em inglês. Veja [Códigos de erro](/errors).
        message:
          type: string
          description: Texto em português para mostrar a uma pessoa.
      additionalProperties: true
    BackupError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          enum:
            - too_large
            - empty
            - backup_failed
          description: >-
            `too_large`: o projeto passa de 500 MB ou de 20.000 arquivos sem as
            dependências. `empty`: não há arquivo para guardar. `backup_failed`:
            falha do nosso lado; tente de novo.
        message:
          type: string
          description: Explicação em português.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API da Cube (`cube_…`), criada no painel em **Chaves de API**.
        Mande como `Authorization: Bearer cube_…`.

````