File Storage Networks

Networks define how file storage services connect to your private networks. Each file storage service can have up to one network attachment for accessing shares via NFS.

GET/1.3/file-storage/{service_uuid}/networks

List networks

Returns a list of network attachments for a file storage service.

Request

GET

/1.3/file-storage/{service_uuid}/networks

curl -X GET https://api.upcloud.com/1.3/file-storage/0ad24fe5-d08a-44ea-a0a8-169a46e0cc90/networks \
  -u your_username:your_password

GET/1.3/file-storage/{service_uuid}/networks/{network_name}

Get network details

Returns details of a specific network attachment.

Request

GET

/1.3/file-storage/{service_uuid}/networks/{network_name}

curl -X GET https://api.upcloud.com/1.3/file-storage/0ad24fe5-d08a-44ea-a0a8-169a46e0cc90/networks/net \
  -u your_username:your_password

POST/1.3/file-storage/{service_uuid}/networks

Create network

Attaches a network to the file storage service.

Attributes

Name
uuid
Type
string
Description
UUID of the SDN network to attach.
Name
name
Type
string
Description
Name for this network attachment (1-64 chars).
Name
family
Type
string
Description
IP address family: "IPv4" or "IPv6".
Name
ip_address
Type
string
Description
Specific IP address to use from the network's DHCP range.

Request

POST

/1.3/file-storage/{service_uuid}/networks

curl -X POST https://api.upcloud.com/1.3/file-storage/0ad24fe5-d08a-44ea-a0a8-169a46e0cc90/networks \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "uuid": "03720d07-80a9-41ac-90b0-68a932109339",
    "name": "private-net",
    "family": "IPv4",
    "ip_address": "192.168.147.150"
  }'

PATCH/1.3/file-storage/{service_uuid}/networks/{network_name}

Modify network

Modifies an existing network attachment. Uses JSON Merge Patch semantics.

Attributes

Name
name
Type
string
Description
Updated network attachment name.
Name
ip_address
Type
string
Description
Updated IP address.

Request

PATCH

/1.3/file-storage/{service_uuid}/networks/{network_name}

curl -X PATCH https://api.upcloud.com/1.3/file-storage/0ad24fe5-d08a-44ea-a0a8-169a46e0cc90/networks/private-net \
  -u your_username:your_password \
  -H "Content-Type: application/json" \
  -d '{
    "ip_address": "192.168.147.200"
  }'

DELETE/1.3/file-storage/{service_uuid}/networks/{network_name}

Delete network

Detaches a network from the file storage service.

Request

DELETE

/1.3/file-storage/{service_uuid}/networks/{network_name}

curl -X DELETE https://api.upcloud.com/1.3/file-storage/0ad24fe5-d08a-44ea-a0a8-169a46e0cc90/networks/private-net \
  -u your_username:your_password