Skip to main content
Use this endpoint to browse the filesystem of your application. Provide a directory path and the API returns every file and subdirectory it contains, along with metadata such as size and last modification time. This is useful for building file-browser UIs, auditing deployments, or verifying that uploaded files are in place.

​
Endpoint

GET https://api.virtuscloud.app/v2/apps/{app_id}/files

​
Authorization

Include your API key in the request header: 
Authorization: <api_key>

​
Path Parameters

​
app_id
string
required
The unique identifier of your application. You can find this in the URL of your application’s dashboard.

​
Query Parameters

​
path
string
required
The directory path to list. Use / or omit trailing slashes to refer to the root. Example: /src to list the contents of the src folder.

​
Response

​
status
string
Indicates the outcome of the request. Returns "success" when the operation completes without errors.
​
response
array
An array of entry objects representing each file or directory found at the specified path.

​
Examples

curl --request GET \
  --url "https://api.virtuscloud.app/v2/apps/{app_id}/files?path=/" \
  --header "Authorization: <api_key>"

​
Response Example

{
  "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": "virtuscloud.app",
      "size": 65,
      "lastModified": 1676169188000
    },
    {
      "type": "directory",
      "name": "src",
      "lastModified": 1676155738000
    }
  ]
}