How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UpCloud File Storage API

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.

UpCloud File Storage API is one of 29 APIs that UpCloud publishes on the 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.

This API exposes 27 operations across 11 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

27 operations 11 paths 36 schemas 5 DELETE11 GET5 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

UpCloud File Storage API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 27

Across 11 paths, the API surfaces 27 operations — 5 DELETE, 11 GET, 5 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

file-storage 27

File Storage is a scalable file storage service that provides shared access to files over a network using the NFS protocol.

GET
/1.3/file-storage
List services
listFileStorages 3 params → 200default
POST
/1.3/file-storage
Create service
createFileStorage body → 201default
GET
/1.3/file-storage/{service-uuid}
Get service details
getFileStorage 1 param → 200default
PUT
/1.3/file-storage/{service-uuid}
Replace service
replaceFileStorage 1 param body → 200default
DELETE
/1.3/file-storage/{service-uuid}
Delete service
deleteFileStorage 1 param → 204default
PATCH
/1.3/file-storage/{service-uuid}
Modify service
modifyFileStorage 1 param body → 200default
GET
/1.3/file-storage/{service-uuid}/networks
List networks
listFileStorageNetworks 1 param → 200default
POST
/1.3/file-storage/{service-uuid}/networks
Create network
createFileStorageNetwork 1 param body → 201default
GET
/1.3/file-storage/{service-uuid}/networks/{network-name}
Get network details
getFileStorageNetwork 2 params → 200default
DELETE
/1.3/file-storage/{service-uuid}/networks/{network-name}
Delete network
deleteFileStorageNetwork 2 params → 204default
PATCH
/1.3/file-storage/{service-uuid}/networks/{network-name}
Modify network
modifyFileStorageNetwork 2 params body → 200default
GET
/1.3/file-storage/{service-uuid}/shares
List shares
listFileStorageShares 1 param → 200default
POST
/1.3/file-storage/{service-uuid}/shares
Create share
createFileStorageShare 1 param body → 201default
GET
/1.3/file-storage/{service-uuid}/shares/{share-name}
Get share details
getFileStorageShare 2 params → 200default
DELETE
/1.3/file-storage/{service-uuid}/shares/{share-name}
Delete share
deleteFileStorageShare 2 params → 204default
PATCH
/1.3/file-storage/{service-uuid}/shares/{share-name}
Modify share
modifyFileStorageShare 2 params body → 200default
GET
/1.3/file-storage/{service-uuid}/shares/{share-name}/acl
List ACLs
listFileStorageAcls 2 params → 200default
POST
/1.3/file-storage/{service-uuid}/shares/{share-name}/acl
Create ACL
createFileStorageAcl 2 params body → 201default
GET
/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}
Get ACL details
getFileStorageAcl 3 params → 200default
DELETE
/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}
Delete ACL
deleteFileStorageAcl 3 params → 204default
PATCH
/1.3/file-storage/{service-uuid}/shares/{share-name}/acl/{acl-name}
Modify ACL
modifyFileStorageAcl 3 params body → 200default
GET
/1.3/file-storage/{service-uuid}/labels
List labels
listFileStorageLabels 1 param → 200default
POST
/1.3/file-storage/{service-uuid}/labels
Create label
createFileStorageLabel 1 param body → 201default
GET
/1.3/file-storage/{service-uuid}/labels/{label-key}
Get label details
getFileStorageLabel 2 params → 200default
DELETE
/1.3/file-storage/{service-uuid}/labels/{label-key}
Delete label
deleteFileStorageLabel 2 params → 204default
PATCH
/1.3/file-storage/{service-uuid}/labels/{label-key}
Modify label
modifyFileStorageLabel 2 params body → 200default
GET
/1.3/file-storage/{service-uuid}/current-state
Get service current state
getFileStorageCurrentState 1 param → 200default

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are fileStorageServiceDetailResponse (13 properties), fileStorageServiceCreate (8 properties), fileStorageErrorResponse (5 properties), fileStorageServiceModify (5 properties). Each schema is shown below with its type and property counts.

fileStorageServiceCreate
object
Schema for creating a new service.
8 properties 4 required
fileStorageLabelCreate
object
Schema for creating a new label.
2 properties 2 required
fileStorageQueryParamSort
string
Query parameter to specify the sorting order of results in API responses, allowing clients to order data based on specific fields.
fileStorageLabelValue
stringnull
Represents the label value.
fileStorageQueryParameterLimit
integer
Schema for the limit query parameter, used to specify the maximum number of items to return in a paginated response.
fileStoragePath
string
The absolute path of the share.
fileStorageConfiguredStatus
string
The service configured status indicates the service's current intended status. Managed by the customer.
fileStorageServiceListResponse
array
Schema for the response containing a list of services.
fileStorageLabelKey
string
Represents the label identifier. The key is unique within a service.
fileStorageShareListResponse
array
Schema for the response containing a list of shares.
fileStorageAclModify
object
Schema for modifying an existing ACL.
3 properties
fileStorageNetworkListResponse
array
Schema for the response containing a list of networks.
fileStorageNetworkDetailResponse
object
Schema for the detailed response of a network.
4 properties
fileStorageNetworkCreate
object
Schema for creating a network.
4 properties 3 required
fileStorageSizeGiB
integer
The size of the service in gibibytes (GiB)
fileStorageShareDetailResponse
object
Schema for the detailed response of a share.
3 properties
fileStorageNetworkFamily
string
Network family. IPv6 currently not supported.
fileStorageName
string
A resource name.
fileStorageLabelModify
object
Schema for modifying an existing label.
2 properties
fileStoragePermission
string
The permission level for the ACL target.
fileStorageServiceReplace
object
Schema for replacing an existing service with a new configuration.
5 properties 3 required
fileStorageErrorResponse
object
Schema for error responses from the API.
5 properties 4 required
fileStorageLabelsListResponse
array
Response schema for listing labels.
fileStorageNetworkUUID
string
Unique identifier for the network.
fileStorageShareModify
object
Schema for modifying an existing share.
2 properties
fileStorageShareCreate
object
Schema for creating a new share with access control lists (ACLs).
3 properties 3 required
fileStorageIPAddress
string
The desired IP address for the service. If not specified, the service will be assigned an IP address from the network's pool.
fileStorageAclCreate
object
Schema for creating an ACL entry.
3 properties 3 required
fileStorageServiceModify
object
Schema for modifying an existing service.
5 properties
fileStorageQueryParamOffset
integer
Query parameter to specify the offset for pagination in API responses, allowing clients to retrieve results starting from a specific point.
fileStorageAclDetailResponse
object
Schema for the detailed response of an ACL.
3 properties
fileStorageLabelDetails
object
Schema for label details including key-value pairs.
2 properties
fileStorageEntityUUID
string
The unique identifier.
fileStorageServiceDetailResponse
object
Schema for the detailed response of a service.
13 properties
fileStorageNetworkModify
object
Schema for modifying an existing network.
4 properties
fileStorageAclListResponse
array
Schema for the response containing a list of ACLs.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-file-storage-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Database API
UpCloud Device API
UpCloud Events API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Ip Address API
UpCloud Kubernetes API
UpCloud Load Balancer API
Where this information came from

This is an independent, third-party profile of UpCloud File Storage API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.