# UpCloud File Storage API

**Canonical:** https://apis.io/apis/upcloud/upcloud-file-storage-api/  
**Provider:** UpCloud — https://apis.io/providers/upcloud/  
**Base URL:** https://api.upcloud.com  
**Documentation:** https://developers.upcloud.com/api/1.3

UpCloud File Storage API is one of 29 APIs that [UpCloud](https://apis.io/providers/upcloud/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include File Storage. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

File Storage is a scalable file storage service that provides shared access to files over a network using the NFS protocol. The File Storage API allows the creation, configuration, and deletion of file storage service, as well as monitoring of network and storage usage. API follows JSON Merge Patch semantics. Note when modifying nested structures payload should contain entire array, which in a sense is PUT within PATCH for them. JSON Merge Patch uses null to explicitly indicate property deletion while absent properties are ignored, i.e. not modified.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/1.3/file-storage` | List services |
| POST | `/1.3/file-storage` | Create service |
| GET | `/1.3/file-storage/{service-uuid}` | Get service details |
| PUT | `/1.3/file-storage/{service-uuid}` | Replace service |
| DELETE | `/1.3/file-storage/{service-uuid}` | Delete service |
| PATCH | `/1.3/file-storage/{service-uuid}` | Modify service |
| GET | `/1.3/file-storage/{service-uuid}/networks` | List networks |
| POST | `/1.3/file-storage/{service-uuid}/networks` | Create network |
| GET | `/1.3/file-storage/{service-uuid}/networks/{network-name}` | Get network details |
| DELETE | `/1.3/file-storage/{service-uuid}/networks/{network-name}` | Delete network |
| PATCH | `/1.3/file-storage/{service-uuid}/networks/{network-name}` | Modify network |
| GET | `/1.3/file-storage/{service-uuid}/shares` | List shares |
| POST | `/1.3/file-storage/{service-uuid}/shares` | Create share |
| GET | `/1.3/file-storage/{service-uuid}/shares/{share-name}` | Get share details |
| DELETE | `/1.3/file-storage/{service-uuid}/shares/{share-name}` | Delete share |
| PATCH | `/1.3/file-storage/{service-uuid}/shares/{share-name}` | Modify share |
| GET | `/1.3/file-storage/{service-uuid}/shares/{share-name}/acl` | List ACLs |
| POST | `/1.3/file-storage/{service-uuid}/shares/{share-name}/acl` | Create ACL |
| GET | `/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}` | Get ACL details |
| DELETE | `/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}` | Delete ACL |
| PATCH | `/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}` | Modify ACL |
| GET | `/1.3/file-storage/{service-uuid}/labels` | List labels |
| POST | `/1.3/file-storage/{service-uuid}/labels` | Create label |
| GET | `/1.3/file-storage/{service-uuid}/labels/{label-key}` | Get label details |
| DELETE | `/1.3/file-storage/{service-uuid}/labels/{label-key}` | Delete label |
| PATCH | `/1.3/file-storage/{service-uuid}/labels/{label-key}` | Modify label |
| GET | `/1.3/file-storage/{service-uuid}/current-state` | Get service current state |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/upcloud/openapi/upcloud-file-storage-api-openapi.yml
- **Documentation** — https://developers.upcloud.com/api/1.3

## Other UpCloud APIs (12)

- [UpCloud Account API](https://apis.io/apis/upcloud/upcloud-account-api/)
- [UpCloud Account Tokens API](https://apis.io/apis/upcloud/upcloud-account-tokens-api/)
- [UpCloud Audit Logs API](https://apis.io/apis/upcloud/upcloud-audit-logs-api/)
- [UpCloud Currency API](https://apis.io/apis/upcloud/upcloud-currency-api/)
- [UpCloud Database API](https://apis.io/apis/upcloud/upcloud-database-api/)
- [UpCloud Device API](https://apis.io/apis/upcloud/upcloud-device-api/)
- [UpCloud Events API](https://apis.io/apis/upcloud/upcloud-events-api/)
- [UpCloud Firewall Ruleset API](https://apis.io/apis/upcloud/upcloud-firewall-ruleset-api/)
- [UpCloud Gateway API](https://apis.io/apis/upcloud/upcloud-gateway-api/)
- [UpCloud Ip Address API](https://apis.io/apis/upcloud/upcloud-ip-address-api/)
- [UpCloud Kubernetes API](https://apis.io/apis/upcloud/upcloud-kubernetes-api/)
- [UpCloud Load Balancer API](https://apis.io/apis/upcloud/upcloud-load-balancer-api/)

## Tags

File Storage

---

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