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

# Ver um projeto

> Um projeto da sua conta, com o status e o uso de agora.

Um projeto da sua conta, com o status e o uso de agora. Útil para acompanhar a instalação depois de [criar](/api-reference/projects/create) ou [enviar código novo](/api-reference/projects/upload-code): consulte até o `status` sair de `installing`.

Quando o `status` é `error` ou `crash_loop`, o campo `error` diz o motivo. Veja [Estados de erro do projeto](/errors#estados-de-erro-do-projeto).


## OpenAPI

````yaml GET /projects/{id}
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 e cuide das variáveis de
    ambiente.
  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
paths:
  /projects/{id}:
    get:
      tags:
        - Projetos
      summary: Ver um projeto
      description: >-
        Um projeto da sua conta, com o status e o uso de agora. Um ID de outra
        conta responde `404`, igual a um que não existe.
      operationId: getProject
      parameters:
        - $ref: '#/components/parameters/ProjectId'
      responses:
        '200':
          description: O projeto.
          content:
            application/json:
              schema:
                type: object
                required:
                  - project
                properties:
                  project:
                    $ref: '#/components/schemas/Project'
              example:
                project:
                  id: 01J8Z3W6N0Q4Y7V2K5T9D1H3XA
                  name: Meu bot
                  description: Atende o servidor da loja
                  type: bot
                  language: node
                  version: '24'
                  entry: index.js
                  command: node index.js
                  memoryMb: 256
                  port: null
                  subdomain: null
                  url: null
                  status: running
                  error: null
                  hasAutoRestart: true
                  consecutiveCrashes: 0
                  lastExit: null
                  usage:
                    memoryMb: 83
                    cpuPercent: 1.2
                    networkInBps: 1200
                    networkOutBps: 300
                  startedAt: '2026-09-26T18:01:05.000Z'
                  createdAt: '2026-09-26T18:00:00.000Z'
                  updatedAt: '2026-09-26T18:01:10.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.
        '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.
        '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.
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl https://app.cubehosting.com.br/api/projects/$PROJECT_ID \
              -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}`,
            { headers });

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

            console.log(project.status, project.usage?.memoryMb);
        - 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.get(f"{API}/projects/{os.environ['PROJECT_ID']}",
            headers=headers, timeout=30)

            r.raise_for_status()

            project = r.json()["project"]

            print(project["status"], project["usage"])
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:
    Project:
      type: object
      description: 'Um projeto: um bot ou um site.'
      required:
        - id
        - name
        - description
        - type
        - language
        - version
        - entry
        - command
        - memoryMb
        - port
        - subdomain
        - url
        - status
        - error
        - hasAutoRestart
        - consecutiveCrashes
        - lastExit
        - usage
        - startedAt
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: ID do projeto, 26 caracteres.
        name:
          type: string
          maxLength: 40
          description: Nome do projeto.
        description:
          type: string
          maxLength: 200
          description: Descrição do painel. `""` quando não tem.
        type:
          type: string
          enum:
            - bot
            - site
        language:
          type: string
          enum:
            - node
            - python
        version:
          type: string
          description: '`20`, `22` ou `24` (Node.js); `3.11` ou `3.12` (Python).'
        entry:
          type:
            - string
            - 'null'
          description: >-
            Arquivo principal: o arquivo que o comando roda, relativo à raiz do
            projeto (como `index.js` ou `src/bot.py`). Vem do `command` quando
            ele é só `node <arquivo>` ou `python <arquivo>`, e muda em
            Configurações › Geral. `null` com um comando próprio, como `npm
            start`.
        command:
          type: string
          description: >-
            Comando de início, o que de fato roda. Quando é `node <entry>` ou
            `python <entry>`, o painel mostra o campo vazio (vazio = roda o
            arquivo principal).
        memoryMb:
          type: integer
          description: Memória reservada, em MB. É também o teto do processo.
        port:
          type:
            - integer
            - 'null'
          description: >-
            Só site: a porta em que o app escuta (também na variável `PORT`).
            `null` em bot.
        subdomain:
          type:
            - string
            - 'null'
          description: 'Só site: o nome em `nome.cubehost.dev`. `null` em bot.'
        url:
          type:
            - string
            - 'null'
          format: uri
          description: 'Só site: o endereço público com HTTPS. `null` em bot.'
        status:
          $ref: '#/components/schemas/ProjectStatus'
        error:
          oneOf:
            - $ref: '#/components/schemas/ProjectError'
            - type: 'null'
          description: O motivo, quando `status` é `error` ou `crash_loop`.
        hasAutoRestart:
          type: boolean
          description: '`true` nos planos pagos: o projeto volta sozinho se cair.'
        consecutiveCrashes:
          type: integer
          description: >-
            Quedas seguidas desde a última vez que rodou 60 segundos sem cair.
            Com 5, o projeto vai para `crash_loop`.
        lastExit:
          oneOf:
            - $ref: '#/components/schemas/LastExit'
            - type: 'null'
          description: A última vez que o processo terminou.
        usage:
          oneOf:
            - $ref: '#/components/schemas/Usage'
            - type: 'null'
          description: O uso de agora. Só com `status` `running`.
        startedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Quando o processo subiu (o "tempo no ar" do painel). Só com
            `running`.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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
    ProjectStatus:
      type: string
      enum:
        - creating
        - installing
        - running
        - stopped
        - restarting
        - crash_loop
        - error
      description: >-
        `creating` (Enviando), `installing` (Instalando), `running` (No ar),
        `stopped` (Parado), `restarting` (Reiniciando), `crash_loop` (Em loop de
        erro), `error` (Com erro).
    ProjectError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          enum:
            - install_failed
            - install_timeout
            - install_out_of_memory
            - install_interrupted
            - start_failed
            - process_exited
            - crash_loop
          description: >-
            Veja [Estados de erro do
            projeto](/errors#estados-de-erro-do-projeto).
        message:
          type: string
          description: Explicação em português.
    LastExit:
      type: object
      required:
        - code
        - isOutOfMemory
        - exitedAt
      properties:
        code:
          type: integer
          description: O código de saída do processo.
        isOutOfMemory:
          type: boolean
          description: '`true` se o processo passou da memória do projeto.'
        exitedAt:
          type: string
          format: date-time
    Usage:
      type: object
      required:
        - memoryMb
        - cpuPercent
        - networkInBps
        - networkOutBps
      properties:
        memoryMb:
          type: integer
          description: Memória em uso, em MB.
        cpuPercent:
          type: number
          description: Uso de processador. 100 = um núcleo inteiro.
        networkInBps:
          type: integer
          description: Rede recebida, em bytes por segundo.
        networkOutBps:
          type: integer
          description: Rede enviada, em bytes por segundo.
  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_…`.

````