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

# Listar arquivos da aplicação

> Liste os arquivos e diretórios de um caminho da aplicação com GET /v2/apps/{app_id}/files, cada um com tipo, tamanho e data da última modificaçã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) `files:read`.

Listar arquivos retorna os arquivos e diretórios em um determinado caminho dentro de uma aplicação, cada entrada trazendo seu tipo, tamanho e data da última modificação. Use-o para navegar pelo armazenamento de uma aplicação a partir de um dashboard ou script antes de ler, gravar ou excluir um arquivo específico.

A listagem reflete o armazenamento da aplicação no nó do cluster no momento da requisição; ela não é armazenada em cache. Combine-o com [Ler arquivo](/pt-br/api-reference/endpoint/apps/filemanager/content) para obter o conteúdo de um arquivo, ou com [Criar/modificar arquivo](/pt-br/api-reference/endpoint/apps/filemanager/put) para gravar um. Omitir `path` lista a raiz da aplicação.

Em aplicações compartilhadas em workspace, quem chama precisa da [função](/pt-br/api-reference/endpoint/workspace/members/invite#funções) `maintain` ou `admin`, e membros sem a permissão de arquivos restritos nunca veem `.env` ou `.env.production` nos resultados; essas entradas são filtradas da resposta em vez de gerar erro.

## Parâmetros

<ParamField path="app_id" type="string" placeholder="ID da Aplicação" required>
  O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.
</ParamField>

<ParamField query="path" type="string" placeholder="Caminho para listar" required>
  O caminho do diretório cujos arquivos você deseja listar, com até 256 caracteres. O padrão é o diretório raiz.
</ParamField>

## Resposta

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

<ResponseField name="response" type="array">
  A lista de arquivos e diretórios no caminho especificado.

  <Expandable title="Alternar objeto">
    <ResponseField name="type" type="string">
      O tipo da entrada. Pode ser `file` ou `directory`.
    </ResponseField>

    <ResponseField name="name" type="string">
      O nome do arquivo ou diretório.
    </ResponseField>

    <ResponseField name="size" type="number">
      O tamanho do arquivo em bytes. Para diretórios, é 0.
    </ResponseField>

    <ResponseField name="lastModified" type="number">
      O timestamp da última modificação do arquivo ou diretório em milissegundos desde a epoch.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={"system"}
  {
      "status": "success",
      "response": [
          {
              "type": "file",
              "name": ".env",
              "size": 86,
              "lastModified": 1676168978000
          },
          {
              "type": "file",
              "name": ".gitignore",
              "size": 8,
              "lastModified": 1675125328000
          },
          {
              "type": "file",
              "name": "index.js",
              "size": 614,
              "lastModified": 1676168350000
          },
          {
              "type": "file",
              "name": "squarecloud.app",
              "size": 65,
              "lastModified": 1676169188000
          },
          {
              "type": "directory",
              "name": "src",
              "lastModified": 1676155738000
          }
      ]
  }
  ```
</ResponseExample>

## Erros comuns

| Código | HTTP | Significado |
| - | - | - |
| `INVALID_PATH` | 400 | O parâmetro de consulta `path` falhou na validação (travessia, caracteres inválidos ou mais de 256 caracteres), ou o cluster não conseguiu ler o diretório. |
| `BLOCKED_PATH` | 403 | O caminho solicitado está dentro de um diretório bloqueado. |
| `FILE_NOT_FOUND` | 404 | O diretório não existe. |

## Relacionados

* CLI: [`squarecloud app file list`](/pt-br/cli-reference/files#squarecloud-app-file-list)
* SDKs: [`api.apps.files.list()`](/pt-br/sdks/js/managing_files) (JavaScript), [`client.apps.files.list()`](/pt-br/sdks/py/managing_files) (Python), [`c.Apps.Files.List()`](/pt-br/sdks/go/managing_files) (Go)


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