# Freestyle Filesystem API

**Canonical:** https://apis.io/apis/freestyle-sh/freestyle-sh-filesystem-api/  
**Provider:** Freestyle — https://apis.io/providers/freestyle-sh/  
**Documentation:** https://docs.freestyle.sh/v2/vms/about

Freestyle Filesystem API is one of 20 APIs that [Freestyle](https://apis.io/providers/freestyle-sh/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Filesystem. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

Read and write files inside a running VM

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| GET | `/v5/vms/{vmIdOrSlug}/fs/dir` | Read dir |
| GET | `/v5/vms/{vmIdOrSlug}/fs/exists` | Path exists |
| POST | `/v5/vms/{vmIdOrSlug}/fs/mkdir` | Make dir |
| GET | `/v5/vms/{vmIdOrSlug}/fs/read` | Read file |
| DELETE | `/v5/vms/{vmIdOrSlug}/fs/remove` | Remove path |
| GET | `/v5/vms/{vmIdOrSlug}/fs/stat` | Stat path |
| POST | `/v5/vms/{vmIdOrSlug}/fs/uploads` | Begin upload |
| GET | `/v5/vms/{vmIdOrSlug}/fs/uploads/{uploadId}` | Upload status |
| PUT | `/v5/vms/{vmIdOrSlug}/fs/uploads/{uploadId}` | Upload chunk |
| DELETE | `/v5/vms/{vmIdOrSlug}/fs/uploads/{uploadId}` | Abort upload |
| POST | `/v5/vms/{vmIdOrSlug}/fs/uploads/{uploadId}/commit` | Commit upload |
| PUT | `/v5/vms/{vmIdOrSlug}/fs/write` | Write file |
| GET | `/vms/{vmIdOrSlug}/fs/dir` | Read dir |
| GET | `/vms/{vmIdOrSlug}/fs/exists` | Path exists |
| POST | `/vms/{vmIdOrSlug}/fs/mkdir` | Make dir |
| GET | `/vms/{vmIdOrSlug}/fs/read` | Read file |
| DELETE | `/vms/{vmIdOrSlug}/fs/remove` | Remove path |
| GET | `/vms/{vmIdOrSlug}/fs/stat` | Stat path |
| POST | `/vms/{vmIdOrSlug}/fs/uploads` | Begin upload |
| GET | `/vms/{vmIdOrSlug}/fs/uploads/{uploadId}` | Upload status |
| PUT | `/vms/{vmIdOrSlug}/fs/uploads/{uploadId}` | Upload chunk |
| DELETE | `/vms/{vmIdOrSlug}/fs/uploads/{uploadId}` | Abort upload |
| POST | `/vms/{vmIdOrSlug}/fs/uploads/{uploadId}/commit` | Commit upload |
| PUT | `/vms/{vmIdOrSlug}/fs/write` | Write file |

## Machine-readable artifacts (28)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/freestyle-sh/refs/heads/main/openapi/freestyle-sh-filesystem-api-openapi.yml
- **Documentation** — https://docs.freestyle.sh/v2/vms/about
- **Documentation** — https://docs.freestyle.sh/v2/vms/lifecycle
- **Documentation** — https://docs.freestyle.sh/v2/vms/configuration
- **Documentation** — https://docs.freestyle.sh/v2/vms/templates-snapshots
- **Documentation** — https://docs.freestyle.sh/v2/vms/ssh-access
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/freestyle-sh/refs/heads/main/json-schema/freestyle-vm-schema.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/freestyle-sh/refs/heads/main/json-ld/freestyle-sh-context.jsonld
- **Documentation** — https://docs.freestyle.sh/v2/git/about
- **Documentation** — https://docs.freestyle.sh/v2/git/repos
- **Documentation** — https://docs.freestyle.sh/v2/git/search
- **Documentation** — https://docs.freestyle.sh/v2/git/hooks
- **Documentation** — https://docs.freestyle.sh/v2/git/github-sync
- **Documentation** — https://docs.freestyle.sh/v2/git/advanced/database-api
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/freestyle-sh/refs/heads/main/json-schema/freestyle-repository-schema.json
- **Documentation** — https://docs.freestyle.sh/v2/about
- **Documentation** — https://docs.freestyle.sh/v2/domains
- **Documentation** — https://docs.freestyle.sh/v2/domains/deploy-to-custom-domain
- **Documentation** — https://docs.freestyle.sh/v2/serverless/runs/about
- **Documentation** — https://docs.freestyle.sh/v2/serverless/runs/code-playground
- **Documentation** — https://docs.freestyle.sh/v2/serverless/runs/egress
- **Documentation** — https://docs.freestyle.sh/v2/serverless/runs/errors
- **Documentation** — https://docs.freestyle.sh/v2/serverless/deployments/about
- **Documentation** — https://docs.freestyle.sh/v2/serverless/deployments/configuration
- **Documentation** — https://docs.freestyle.sh/v2/serverless/deployments/cron-jobs
- **Documentation** — https://docs.freestyle.sh/v2/serverless/deployments/guides/nextjs
- **Documentation** — https://docs.freestyle.sh/v2/serverless/deployments/guides/vite
- **Documentation** — https://docs.freestyle.sh/v2/serverless/deployments/guides/static

## Other Freestyle APIs (12)

- [Freestyle Auth API](https://apis.io/apis/freestyle-sh/freestyle-sh-auth-api/)
- [Freestyle Certs API](https://apis.io/apis/freestyle-sh/freestyle-sh-certs-api/)
- [Freestyle Cron API](https://apis.io/apis/freestyle-sh/freestyle-sh-cron-api/)
- [Freestyle DNS API](https://apis.io/apis/freestyle-sh/freestyle-sh-dns-api/)
- [Freestyle Domains API](https://apis.io/apis/freestyle-sh/freestyle-sh-domains-api/)
- [Freestyle Execute API](https://apis.io/apis/freestyle-sh/freestyle-sh-execute-api/)
- [Freestyle Git API](https://apis.io/apis/freestyle-sh/freestyle-sh-git-api/)
- [Freestyle Identity API](https://apis.io/apis/freestyle-sh/freestyle-sh-identity-api/)
- [Freestyle Observability API](https://apis.io/apis/freestyle-sh/freestyle-sh-observability-api/)
- [Freestyle Web API](https://apis.io/apis/freestyle-sh/freestyle-sh-web-api/)
- [Freestyle Background requests API](https://apis.io/apis/freestyle-sh/freestyle-sh-background-requests-api/)
- [Freestyle Firewall API](https://apis.io/apis/freestyle-sh/freestyle-sh-firewall-api/)

## Tags

Filesystem

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/freestyle-sh/freestyle-sh-filesystem-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/freestyle-sh/.