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

# Listar domínios da conta

> Os domínios próprios de todos os sites da conta, com o status e os registros DNS.

Cada domínio vem com o site que ele abre (`project`), o status e, em `records`, os dois registros para criar no DNS dele. `used` e `limit` são da conta inteira: o `www` conta como um domínio. Com `isAvailable: false`, o domínio próprio ainda não está liberado para a conta. Guia em [Endereço e domínios](/hosting/domains).

## Erros comuns

| Código                                                     | HTTP | O que fazer                                          |
| ---------------------------------------------------------- | ---- | ---------------------------------------------------- |
| [`invalid_api_key`](/errors#param-invalid-api-key)         | 401  | Confira o cabeçalho `Authorization: Bearer <chave>`. |
| [`rate_limit_exceeded`](/errors#param-rate-limit-exceeded) | 429  | Espere os segundos do `Retry-After`.                 |

Todos os códigos, com o formato do erro, em [Códigos de erro](/errors).


## OpenAPI

````yaml GET /domains
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, faça e baixe backups, volte para uma versão anterior, crie bancos
    de dados (PostgreSQL, MySQL, MongoDB e Redis), guarde arquivos privados no
    Blob, use um domínio seu nos sites e veja o uso do plano. Para agentes de
    IA, o servidor MCP da conta (`POST https://app.cubehosting.com.br/api/mcp`,
    JSON-RPC, com a mesma chave) está em
    https://docs.cubehosting.com.br/account-mcp.
  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
  - name: Versões dos envios
  - name: Bancos de dados
  - name: Blob
  - name: Domínios
  - name: Templates
  - name: Avisos
  - name: Conta
paths:
  /domains:
    get:
      tags:
        - Domínios
      summary: Listar domínios da conta
      description: >-
        Os domínios próprios de todos os sites da conta, cada um com o site
        (`project`), o status e os registros DNS para criar. `used` e `limit`
        são da conta inteira (o `www` conta como um). Guia em [Endereço e
        domínios](/hosting/domains).
      operationId: listDomains
      responses:
        '200':
          description: Os domínios da conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainList'
              example:
                domains:
                  - id: 01JA9K3M5P7R9T1V3X5Z7B9D1F
                    projectId: 01J8Z4B2QK7M3V9T0XW5R6N8CD
                    hostname: loja.com.br
                    redirectTo: null
                    status: active
                    error: null
                    records:
                      - type: CNAME
                        name: loja.com.br
                        value: domains.cubehost.dev
                        isOk: true
                      - type: TXT
                        name: _cube-verify.loja.com.br
                        value: cube-verify=4a4163549b3f77ae5fbfff6fa7480999
                        isOk: true
                    verifiedAt: '2026-09-28T15:11:01.597Z'
                    checkedAt: '2026-09-28T15:21:02.114Z'
                    createdAt: '2026-09-28T15:09:40.000Z'
                    project:
                      id: 01J8Z4B2QK7M3V9T0XW5R6N8CD
                      name: Loja
                  - id: 01JA9K3M5P7R9T1V3X5Z7B9D1G
                    projectId: 01J8Z4B2QK7M3V9T0XW5R6N8CD
                    hostname: www.loja.com.br
                    redirectTo: loja.com.br
                    status: pending
                    error: null
                    records:
                      - type: CNAME
                        name: www.loja.com.br
                        value: domains.cubehost.dev
                        isOk: false
                      - type: TXT
                        name: _cube-verify.loja.com.br
                        value: cube-verify=4a4163549b3f77ae5fbfff6fa7480999
                        isOk: true
                    verifiedAt: '2026-09-28T15:11:01.597Z'
                    checkedAt: '2026-09-28T15:21:02.114Z'
                    createdAt: '2026-09-28T15:09:40.000Z'
                    project:
                      id: 01J8Z4B2QK7M3V9T0XW5R6N8CD
                      name: Loja
                used: 2
                limit: 10
                target: domains.cubehost.dev
                isAvailable: true
        '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.
        '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/domains \
              -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}/domains`, { headers });

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

            for (const d of domains) console.log(d.hostname, d.status,
            d.project.name);
        - 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}/domains", headers=headers, timeout=30)
            r.raise_for_status()
            for d in r.json()["domains"]:
                print(d["hostname"], d["status"], d["project"]["name"])
components:
  schemas:
    DomainList:
      type: object
      required:
        - domains
        - used
        - limit
        - target
        - isAvailable
      properties:
        domains:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
        used:
          type: integer
          description: Quantos domínios a conta tem, somando os sites.
        limit:
          type: integer
          description: >-
            O limite do plano: 0 abaixo do Tower; Tower 10, Fortress 20,
            Monolith 40.
        target:
          type: string
          description: O alvo do CNAME (`domains.cubehost.dev`).
        isAvailable:
          type: boolean
          description: >-
            `false` enquanto o domínio próprio ainda não está liberado para a
            conta (em breve).
    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
    Domain:
      type: object
      description: Um domínio próprio de um site.
      required:
        - id
        - projectId
        - hostname
        - redirectTo
        - status
        - error
        - records
        - verifiedAt
        - checkedAt
        - createdAt
        - project
      properties:
        id:
          type: string
          description: ID do domínio (26 caracteres).
        projectId:
          type: string
          description: O site que o domínio abre.
        hostname:
          type: string
          description: >-
            O domínio, em minúsculas (acento em punycode: `café.com.br` →
            `xn--caf-dma.com.br`).
        redirectTo:
          type:
            - string
            - 'null'
          description: >-
            Outro domínio do site para onde este redireciona (`308`, com o
            caminho); `null` = abre o site.
        status:
          type: string
          enum:
            - pending
            - active
            - error
          description: >-
            `pending`: falta o TXT ou o CNAME (verificando). `active`:
            verificado e chegando à Cube. `error`: veja `error`.
        error:
          oneOf:
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                  enum:
                    - verification_expired
                    - domain_taken
                    - certificate_failed
                    - plan_not_allowed
                message:
                  type: string
            - type: 'null'
          description: >-
            `verification_expired`: sem o TXT em 7 dias. `domain_taken`: outra
            conta provou a posse antes. `certificate_failed`: o HTTPS não saiu.
            `plan_not_allowed`: o plano de agora não tem domínio próprio.
        records:
          type: array
          items:
            $ref: '#/components/schemas/DomainRecord'
          description: Os dois registros para criar no DNS do domínio.
        verifiedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Quando a posse foi provada; `null` até achar o TXT.
        checkedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: A última conferência.
        createdAt:
          type: string
          format: date-time
        project:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
            name:
              type: string
    DomainRecord:
      type: object
      required:
        - type
        - name
        - value
        - isOk
      properties:
        type:
          type: string
          enum:
            - CNAME
            - TXT
        name:
          type: string
          description: >-
            O nome do registro. O TXT fica em `_cube-verify.<domínio sem o
            www>`: o `www` e a raiz usam o mesmo.
        value:
          type: string
          description: >-
            O valor: `domains.cubehost.dev` no CNAME; `cube-verify=<token>` no
            TXT.
        isOk:
          type: boolean
          description: Se a Cube já achou o registro certo.
  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_…`.

````