File Storage
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.
List File Storage services
Returns File Storage services in the customer account. Results can be paginated, sorted by creation time, and filtered by one or more labels. When multiple label parameters are supplied, a service must match every filter.
query Parameters
limitMaximum number of services to return.
Maximum number of entries to return. The default is 10 and the maximum is 100. Set to 0 to return an empty page while still receiving the total count where supported.
offsetNumber of matching services to skip before returning results.
Number of matching entries to skip before returning a page. The default is 0.
sortCreation-time order for returned services.
Creation-time order for returned entries. created_at sorts oldest first and -created_at sorts newest first. The default is created_at.
labelFilters services by label. Use a key such as environment to require that label, or a key-value pair such as environment=production for an exact value match. Label keys are matched case-insensitively; values are case-sensitive. Repeat this parameter to require all filters.
Label filters in key or key=value form. A key filters by label existence; a key-value pair filters by an exact value. Label keys are matched case-insensitively and values are case-sensitive. Services must match every filter.
List File Storage services › Responses
The File Storage services matching all filters are returned.
File Storage services in the customer account.
uuidUUID of the File Storage resource.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredUpCloud zone in which the service is hosted.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
operational_stateSystem-managed service lifecycle state. Transitional states describe provisioning or deletion work; running and stopped are stable states.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedWhether immutable AES-256-GCM encryption at rest is enabled.
Private networks attached to the service.
NFS shares configured for the service.
Labels attached to the service.
Latest capacity and inode usage measurements for the File Storage service.
created_atTime at which the service was created.
updated_atTime at which the service was last updated.
Create a File Storage service
Creates a File Storage service that exposes shares over NFS. The service name must be unique within the customer account. Creation is asynchronous: the returned service initially has the pending operational state while its resources are provisioned.
Create a File Storage service › Request Body
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredValid UpCloud zone in which the File Storage service is created. An attached private network must be in this same zone.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedEnables AES-256-GCM encryption at rest. Encryption is disabled by default and cannot be changed after the service is created.
Private network attachments to create with the service. At most one network can be attached, and it must be in the service zone.
NFS shares to create with the service. The API currently supports at most 50 shares per service.
Labels attached to the service for metadata and list filtering. Label keys must be unique within the service.
Create a File Storage service › Responses
The File Storage service was created and its desired configuration is returned.
uuidUUID of the File Storage resource.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredUpCloud zone in which the service is hosted.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
operational_stateSystem-managed service lifecycle state. Transitional states describe provisioning or deletion work; running and stopped are stable states.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedWhether immutable AES-256-GCM encryption at rest is enabled.
Private networks attached to the service.
NFS shares configured for the service.
Labels attached to the service.
Latest capacity and inode usage measurements for the File Storage service.
created_atTime at which the service was created.
updated_atTime at which the service was last updated.
Get File Storage service details
Returns the desired configuration, lifecycle state, and latest available capacity metrics for the File Storage service identified by {service-uuid}.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Get File Storage service details › Responses
The File Storage service details are returned.
uuidUUID of the File Storage resource.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredUpCloud zone in which the service is hosted.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
operational_stateSystem-managed service lifecycle state. Transitional states describe provisioning or deletion work; running and stopped are stable states.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedWhether immutable AES-256-GCM encryption at rest is enabled.
Private networks attached to the service.
NFS shares configured for the service.
Labels attached to the service.
Latest capacity and inode usage measurements for the File Storage service.
created_atTime at which the service was created.
updated_atTime at which the service was last updated.
Replace File Storage service configuration
Replaces the mutable configuration of the File Storage service identified by {service-uuid}. name, configured_status, and size_gib are required. The networks and labels collections are replaced in full; omitting either collection clears it. The service size can be increased but not reduced. The service zone, encryption setting, and shares are not changed by this operation.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Replace File Storage service configuration › Request Body
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
Complete replacement for the service's attached private networks. Omit this property or supply an empty array to detach all networks. At most one network can be attached, and it must be in the service zone.
Complete replacement for the service's labels. Omit this property or supply an empty array to remove all labels.
Replace File Storage service configuration › Responses
The replacement configuration was accepted and the updated desired service state is returned.
uuidUUID of the File Storage resource.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredUpCloud zone in which the service is hosted.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
operational_stateSystem-managed service lifecycle state. Transitional states describe provisioning or deletion work; running and stopped are stable states.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedWhether immutable AES-256-GCM encryption at rest is enabled.
Private networks attached to the service.
NFS shares configured for the service.
Labels attached to the service.
Latest capacity and inode usage measurements for the File Storage service.
created_atTime at which the service was created.
updated_atTime at which the service was last updated.
Delete a File Storage service
Schedules the File Storage service identified by {service-uuid} for asynchronous deletion. The service enters its deletion lifecycle after this request and its storage resources are subsequently torn down.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Delete a File Storage service › Responses
The File Storage service was accepted for deletion. No response body is returned.
Modify File Storage service configuration
Partially modifies the mutable configuration of the File Storage service identified by {service-uuid} using JSON Merge Patch semantics. Omitted fields remain unchanged. A supplied networks or labels array replaces the complete collection; an empty array or null clears that collection. The service size can be increased but not reduced. The service zone, encryption setting, and shares cannot be modified by this operation.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Modify File Storage service configuration › Request Body
name^[a-zA-Z0-9_-]+$A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
Complete replacement for the service's attached private networks. An empty array or null detaches all networks. At most one network can be attached, and it must be in the service zone.
Complete replacement for the service's labels. An empty array or null removes all labels.
Modify File Storage service configuration › Responses
The modification was accepted and the updated desired service state is returned.
uuidUUID of the File Storage resource.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredUpCloud zone in which the service is hosted.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
operational_stateSystem-managed service lifecycle state. Transitional states describe provisioning or deletion work; running and stopped are stable states.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedWhether immutable AES-256-GCM encryption at rest is enabled.
Private networks attached to the service.
NFS shares configured for the service.
Labels attached to the service.
Latest capacity and inode usage measurements for the File Storage service.
created_atTime at which the service was created.
updated_atTime at which the service was last updated.
List attached networks
Returns the private networks attached to the File Storage service identified by {service-uuid}. The list contains at most one attachment.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
List attached networks › Responses
The attached private networks are returned.
Private networks attached to a File Storage service. A service can have at most one attached network.
familyAddress family of the private network attachment. Only IPv4 is currently supported.
ip_addressIPv4 address assigned to the File Storage service in the private network. When creating an attachment, omission allocates a free address from the network's IPv4 pool. When modifying an attachment, omission preserves the current address and null is not accepted; supply an address from the replacement network when changing uuid. A supplied address must be available.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
uuidUUID of an accessible private network in the same zone as the File Storage service.
Attach a private network
Attaches a private network to the File Storage service identified by {service-uuid}. A service can have at most one attached network. The network must be accessible to the customer and in the same zone as the service, and its attachment name must be unique within the service. Only IPv4 is supported. When ip_address is omitted, a free address is allocated from the private network's IPv4 pool.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Attach a private network › Request Body
uuidUUID of an accessible private network in the same zone as the File Storage service.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
familyAddress family of the private network attachment. Only IPv4 is currently supported.
ip_addressIPv4 address assigned to the File Storage service in the private network. When creating an attachment, omission allocates a free address from the network's IPv4 pool. When modifying an attachment, omission preserves the current address and null is not accepted; supply an address from the replacement network when changing uuid. A supplied address must be available.
Attach a private network › Responses
The private network was attached and the attachment details are returned.
familyAddress family of the private network attachment. Only IPv4 is currently supported.
ip_addressIPv4 address assigned to the File Storage service in the private network. When creating an attachment, omission allocates a free address from the network's IPv4 pool. When modifying an attachment, omission preserves the current address and null is not accepted; supply an address from the replacement network when changing uuid. A supplied address must be available.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
uuidUUID of an accessible private network in the same zone as the File Storage service.
Get an attached network
Returns the private network attachment named {network-name} from the File Storage service identified by {service-uuid}. Network attachment names are scoped to a service.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
network-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the private network attachment.
A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
Get an attached network › Responses
The private network attachment is returned.
familyAddress family of the private network attachment. Only IPv4 is currently supported.
ip_addressIPv4 address assigned to the File Storage service in the private network. When creating an attachment, omission allocates a free address from the network's IPv4 pool. When modifying an attachment, omission preserves the current address and null is not accepted; supply an address from the replacement network when changing uuid. A supplied address must be available.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
uuidUUID of an accessible private network in the same zone as the File Storage service.
Detach a private network
Detaches the private network attachment named {network-name} from the File Storage service identified by {service-uuid}. This removes the service's network interface during reconciliation but does not delete the underlying private network.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
network-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the private network attachment.
A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
Detach a private network › Responses
The private network attachment was accepted for removal. No response body is returned.
Modify an attached network
Partially modifies the private network attachment named {network-name} on the File Storage service identified by {service-uuid}. Omitted fields remain unchanged, including ip_address; null is not accepted. When selecting a different private network, supply an address from that network. The attachment name must remain unique within the service, the selected private network must be accessible and in the service zone, and only IPv4 is supported.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
network-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the private network attachment.
A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
Modify an attached network › Request Body
uuidUUID of an accessible private network in the same zone as the File Storage service.
name^[a-zA-Z0-9_-]+$A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
familyAddress family of the private network attachment. Only IPv4 is currently supported.
ip_addressIPv4 address assigned to the File Storage service in the private network. When creating an attachment, omission allocates a free address from the network's IPv4 pool. When modifying an attachment, omission preserves the current address and null is not accepted; supply an address from the replacement network when changing uuid. A supplied address must be available.
Modify an attached network › Responses
The private network attachment was modified and its details are returned.
familyAddress family of the private network attachment. Only IPv4 is currently supported.
ip_addressIPv4 address assigned to the File Storage service in the private network. When creating an attachment, omission allocates a free address from the network's IPv4 pool. When modifying an attachment, omission preserves the current address and null is not accepted; supply an address from the replacement network when changing uuid. A supplied address must be available.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
uuidUUID of an accessible private network in the same zone as the File Storage service.
List NFS shares
Returns the shares on the File Storage service identified by {service-uuid}, ordered by path. A share undergoing asynchronous deletion remains in the list with deleting set to true until its backing directory and stored configuration have been removed.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
List NFS shares › Responses
The service shares are returned.
NFS shares configured on a File Storage service, ordered by path. Shares undergoing asynchronous deletion remain present with deleting set to true until cleanup finishes.
name^[a-zA-Z0-9_-]+$ · requiredService-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
path^/[a-zA-Z0-9/_-]*$ · requiredAbsolute path of the system-managed backing directory. The path is immutable after creation. Deleting the share permanently deletes this directory and all content below it.
Access-control entries for the NFS export. An empty array means the share has no direct export access, although a nested share may remain visible through a parent export.
deletingIndicates that asynchronous deletion of the share and its backing directory is in progress. Omitted when false.
Create an NFS share
Creates an NFS share on the File Storage service identified by {service-uuid}. The share name and immutable absolute path must each be unique within the service, which can have at most 50 active shares. The system creates the backing directory. An empty acl array leaves the share without direct export access, although a nested share may remain visible through a parent export. When multiple parent or child rules match a client, the most permissive permission determines effective access.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Create an NFS share › Request Body
name^[a-zA-Z0-9_-]+$ · requiredService-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
path^/[a-zA-Z0-9/_-]*$ · requiredAbsolute path of the system-managed backing directory. The path is immutable after creation. Deleting the share permanently deletes this directory and all content below it.
Access-control entries for the NFS export. An empty array leaves the share without direct export access. Nested shares may still be visible through a parent share, and the most permissive matching entry determines effective access.
Create an NFS share › Responses
The NFS share was created and its details are returned.
name^[a-zA-Z0-9_-]+$ · requiredService-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
path^/[a-zA-Z0-9/_-]*$ · requiredAbsolute path of the system-managed backing directory. The path is immutable after creation. Deleting the share permanently deletes this directory and all content below it.
Access-control entries for the NFS export. An empty array means the share has no direct export access, although a nested share may remain visible through a parent export.
deletingIndicates that asynchronous deletion of the share and its backing directory is in progress. Omitted when false.
Get an NFS share
Returns the share named {share-name} from the File Storage service identified by {service-uuid}. Share names are unique within a service. A share undergoing asynchronous deletion remains addressable with deleting set to true until cleanup finishes.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
Get an NFS share › Responses
The NFS share details are returned.
name^[a-zA-Z0-9_-]+$ · requiredService-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
path^/[a-zA-Z0-9/_-]*$ · requiredAbsolute path of the system-managed backing directory. The path is immutable after creation. Deleting the share permanently deletes this directory and all content below it.
Access-control entries for the NFS export. An empty array means the share has no direct export access, although a nested share may remain visible through a parent export.
deletingIndicates that asynchronous deletion of the share and its backing directory is in progress. Omitted when false.
Delete an NFS share
Permanently deletes the share named {share-name} from the File Storage service identified by {service-uuid}, including its backing directory and all content below that path. Deletion is asynchronous: the share remains visible with deleting set to true until cleanup finishes. A share cannot be accepted for deletion while it contains another active share; delete nested shares first.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
Delete an NFS share › Responses
The NFS share was accepted for permanent deletion. No response body is returned.
Modify an NFS share
Partially modifies the share named {share-name} on the File Storage service identified by {service-uuid}. Omitted fields remain unchanged and null is not accepted. A supplied acl array replaces the complete access-control collection; an empty array removes direct export access. The share path is immutable and cannot be supplied. A renamed share must remain unique within the service.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
Modify an NFS share › Request Body
name^[a-zA-Z0-9_-]+$Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
Complete replacement access-control collection for the NFS export. Omit this property to retain all current entries. An empty array removes direct export access; a nested share may still be visible through a parent export. When multiple parent or child rules match a client, the most permissive permission determines effective access.
Modify an NFS share › Responses
The NFS share was modified and its details are returned.
name^[a-zA-Z0-9_-]+$ · requiredService-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
path^/[a-zA-Z0-9/_-]*$ · requiredAbsolute path of the system-managed backing directory. The path is immutable after creation. Deleting the share permanently deletes this directory and all content below it.
Access-control entries for the NFS export. An empty array means the share has no direct export access, although a nested share may remain visible through a parent export.
deletingIndicates that asynchronous deletion of the share and its backing directory is in progress. Omitted when false.
List share ACL entries
Returns the access-control entries for the NFS export of share {share-name} on the File Storage service identified by {service-uuid}, ordered by target.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
List share ACL entries › Responses
The share ACL entries are returned.
Access-control entries configured for a share's NFS export, ordered by target.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
targetClient allowed to access the export, expressed as an IP address, a CIDR network prefix, or * for all clients.
permissionNFS export permission granted to the ACL target: ro for read-only access or rw for read-write access.
Create a share ACL entry
Creates an access-control entry for the NFS export of share {share-name} on the File Storage service identified by {service-uuid}. The entry name and target must each be unique within the share. A target is an IP address, CIDR network prefix, or *; ro grants read-only access and rw grants read-write access. For nested shares, matching parent and child rules combine and the most permissive permission determines effective access.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
Create a share ACL entry › Request Body
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
targetClient allowed to access the export, expressed as an IP address, a CIDR network prefix, or * for all clients.
permissionNFS export permission granted to the ACL target: ro for read-only access or rw for read-write access.
Create a share ACL entry › Responses
The share ACL entry was created and its details are returned.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
targetClient allowed to access the export, expressed as an IP address, a CIDR network prefix, or * for all clients.
permissionNFS export permission granted to the ACL target: ro for read-only access or rw for read-write access.
Get a share ACL entry
Returns the access-control entry named {acl-name} from share {share-name} on the File Storage service identified by {service-uuid}. ACL entry names are unique within a share.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
acl-name^[a-zA-Z0-9_-]+$ · requiredShare-scoped name of the access-control entry.
A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
Get a share ACL entry › Responses
The share ACL entry is returned.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
targetClient allowed to access the export, expressed as an IP address, a CIDR network prefix, or * for all clients.
permissionNFS export permission granted to the ACL target: ro for read-only access or rw for read-write access.
Delete a share ACL entry
Removes the access-control entry named {acl-name} from share {share-name} on the File Storage service identified by {service-uuid}. Removing the final entry leaves the share without direct NFS export access, although a nested share may remain visible through a parent export.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
acl-name^[a-zA-Z0-9_-]+$ · requiredShare-scoped name of the access-control entry.
A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
Delete a share ACL entry › Responses
The share ACL entry was removed. No response body is returned.
Modify a share ACL entry
Partially modifies the access-control entry named {acl-name} on share {share-name} of the File Storage service identified by {service-uuid}. Omitted fields remain unchanged and null is not accepted. The resulting name and target must each remain unique within the share. A target is an IP address, CIDR network prefix, or *; permission is ro for read-only or rw for read-write access.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
share-name^[a-zA-Z0-9_-]+$ · requiredService-scoped name of the share.
Service-scoped share name. It must contain 1-128 letters, digits, underscores, or hyphens and be unique within the service.
acl-name^[a-zA-Z0-9_-]+$ · requiredShare-scoped name of the access-control entry.
A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
Modify a share ACL entry › Request Body
name^[a-zA-Z0-9_-]+$A 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
targetClient allowed to access the export, expressed as an IP address, a CIDR network prefix, or * for all clients.
permissionNFS export permission granted to the ACL target: ro for read-only access or rw for read-write access.
Modify a share ACL entry › Responses
The share ACL entry was modified and its details are returned.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
targetClient allowed to access the export, expressed as an IP address, a CIDR network prefix, or * for all clients.
permissionNFS export permission granted to the ACL target: ro for read-only access or rw for read-write access.
List service labels
Returns the labels attached to the File Storage service identified by {service-uuid}. An empty service label collection is returned as an empty array.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
List service labels › Responses
The labels attached to the service are returned.
Labels attached to a File Storage service. An empty collection is returned as an empty array.
keyvalueCreate a service label
Creates a label on the File Storage service identified by {service-uuid}. A service can have at most 255 labels, and each key must be unique within the service regardless of case. Labels can filter the service list by key existence or an exact key-value match; repeated filters must all match.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Create a service label › Request Body
key^[\x20-\x5E\x60-\x7E… · requiredService-scoped label key. It must contain 2-32 printable ASCII characters, must not start with _, and must be unique within the service regardless of case.
value\A[\p{L}\p{N}\p{P}\p… · requiredLabel value supplied when modifying a label. A string may be empty and can contain up to 255 Unicode letters, numbers, punctuation, symbols, marks, and separators. null is accepted and stored as an empty string; it does not delete the label.
Create a service label › Responses
The service label was created and its details are returned.
keyvalueGet a service label
Returns the label identified by {label-key} from the File Storage service identified by {service-uuid}. Label keys are unique within a service and lookup is case-insensitive; the response contains the stored key casing.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
label-key^[\x20-\x5E\x60-\x7E… · requiredService-scoped key of the label. Lookup is case-insensitive.
Service-scoped label key. It must contain 2-32 printable ASCII characters, must not start with _, and must be unique within the service regardless of case.
Get a service label › Responses
The service label is returned.
keyvalueDelete a service label
Removes the label identified by {label-key} from the File Storage service identified by {service-uuid}. Future service-list label filters no longer match the removed key or key-value pair. Label-key lookup is case-insensitive.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
label-key^[\x20-\x5E\x60-\x7E… · requiredService-scoped key of the label. Lookup is case-insensitive.
Service-scoped label key. It must contain 2-32 printable ASCII characters, must not start with _, and must be unique within the service regardless of case.
Delete a service label › Responses
The service label was removed. No response body is returned.
Modify a service label
Modifies the label identified by {label-key} on the File Storage service identified by {service-uuid}. Supply both key and value: the current implementation replaces an omitted field with an empty string rather than preserving it. Supplying value as null also stores an empty string and does not delete the label. The resulting key must remain unique within the service regardless of case.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
label-key^[\x20-\x5E\x60-\x7E… · requiredService-scoped key of the label. Lookup is case-insensitive.
Service-scoped label key. It must contain 2-32 printable ASCII characters, must not start with _, and must be unique within the service regardless of case.
Modify a service label › Request Body
key^[\x20-\x5E\x60-\x7E…Service-scoped label key. It must contain 2-32 printable ASCII characters, must not start with _, and must be unique within the service regardless of case.
value\A[\p{L}\p{N}\p{P}\p…Label value supplied when modifying a label. A string may be empty and can contain up to 255 Unicode letters, numbers, punctuation, symbols, marks, and separators. null is accepted and stored as an empty string; it does not delete the label.
Modify a service label › Responses
The service label was modified and its details are returned.
keyvalueGet the applied File Storage service state
Returns the latest successfully reported state of the File Storage service identified by {service-uuid} after configuration has been applied to the primary storage instance. Newly requested changes can appear in the regular service response before they appear here. A service without an applied-state snapshot returns 404; this normally occurs before it has reached the running operational state.
path Parameters
service-uuidUUID of the File Storage service.
UUID of the File Storage resource.
Get the applied File Storage service state › Responses
The latest applied File Storage service state is returned.
uuidUUID of the File Storage resource.
name^[a-zA-Z0-9_-]+$ · requiredA 1-64 character service, network, or ACL name containing only letters, digits, underscores, and hyphens. Names must be unique within the resource's documented scope.
zone^[a-z]{2}-[a-z]{3}\d… · requiredUpCloud zone of the service.
configured_statusCustomer-managed intended service status. started requests an available service; stopped requests that the service be stopped while retaining its configuration and data.
operational_stateOperational state reported for the applied instance configuration.
size_gibAllocated File Storage capacity in gibibytes (GiB), from 250 to 25000. After creation, capacity can be increased but not reduced.
encryptedWhether AES-256-GCM encryption at rest is enabled on the applied storage instance.
Network endpoints reported by the applied storage instance.
NFS shares reported by the applied storage instance.
Labels copied from the control-plane service when this snapshot was created.
Latest capacity and inode usage measurements for the File Storage service.
created_atCreation time reported by the applied storage instance.
updated_atLast update time reported by the applied storage instance.