> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.xapi.to/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.xapi.to/_mcp/server.

# 列出文件

GET https://sandbox.xapi.to/v1/sandboxes/{id}/files/list

按限定深度列出实例工作区中的目录和文件，适合在读取制品前确认路径。

Reference: https://docs.xapi.to/sandbox/api-reference/execution/list-files

## Authentication

- `XAPI-Key` header (required) — 在 xAPI Console 创建的 API Key。只会发送给 *.xapi.to。

## Servers

- `https://sandbox.xapi.to` (Production, default)
- `https://sandbox.test.xapi.to` (Test)

## Request

### Path parameters

- `id` (string, required) — xAPI Sandbox 实例 UUID。

### Query parameters

- `path` (string, required) — 要枚举的工作区目录；使用 `.` 表示当前工作区根目录。
- `depth` (integer, optional) — 递归列出的最大层数，取值 1–20；值越大返回条目可能越多。

## Response

### 200

文件条目

- `entries` (list of FileEntry, required) — 枚举结果；空数组表示路径存在但没有匹配条目，路径不存在通常返回错误。

## Types

### FileEntry

工作区目录枚举返回的一项；供应商可以附加时间戳、权限等字段。

- `name` (string, optional) — 文件或目录的基本名称。
- `path` (string, optional) — 相对于枚举根目录或工作区的路径。
- `type` (enum, optional) — 条目类型：普通文件、目录或供应商特有类型。
  - Allowed values: `file`, `dir`, `other`
- `size` (integer, optional) — 文件字节数；目录或未知大小时可能省略。

## Examples

**Response**

```json
{
  "entries": [
    {
      "path": "input.txt",
      "type": "file",
      "size": 45
    },
    {
      "path": "result.txt",
      "type": "file",
      "size": 19
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list"

querystring = {"depth":"2","path":"."}

headers = {"XAPI-Key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=.';
const options = {method: 'GET', headers: {'XAPI-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=."

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("XAPI-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=.")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["XAPI-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=.")
  .header("XAPI-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=.', [
  'headers' => [
    'XAPI-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=.");
var request = new RestRequest(Method.GET);
request.AddHeader("XAPI-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["XAPI-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files/list?depth=2&path=.")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```