Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
File Shares

Get file share

get/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

file_share_idstring uuid4 required

File Share ID

Example:bd8c47ee-e565-4e26-8840-b537e6827b08

File Share ID

Response

OK

connection_pointstring nullable required

Connection point. Can be null during File share creation

created_atstring required

Datetime when the file share was created

creator_task_idstring uuid4 required

Task that created this entity

idstring uuid4 required

File share ID

namestring required

File share name

network_idstring uuid4 required

Network ID.

network_namestring required

Network name.

project_idinteger required

Project ID

protocolstring required

File share protocol

regionstring required

Region name

region_idinteger required

Region ID

share_network_namestring nullable required

Share network name. May be null if the file share was created with volume type VAST

sizeinteger required

File share size in GiB

status'available' | 'awaiting_transfer' | 'backup_creating' | 'backup_restoring' | 'backup_restoring_error' | 'creating' | 'creating_from_snapshot' | 'deleted' | 'deleting' | 'ensuring' | 'error' | 'error_deleting' | 'extending' | 'extending_error' | 'inactive' | 'manage_error' | 'manage_starting' | 'migrating' | 'migrating_to' | 'replication_change' | 'reverting' | 'reverting_error' | 'shrinking' | 'shrinking_error' | 'shrinking_possible_data_loss_error' | 'unmanage_error' | 'unmanage_starting' | 'unmanaged' required
subnet_idstring uuid4 required

Subnet ID.

subnet_namestring required

Subnet name.

task_idstring uuid4 nullable required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

type_name'standard' | 'vast' required
volume_type'default_share_type' | 'vast_share_type' required

Example response

{
  "connection_point": "10.254.0.43:/shares/share-7c14ca01-ea5e-4d85-a6e2-c104fe6b561a",
  "created_at": "2023-04-25T11:06:49.226920",
  "creator_task_id": "6ab1ead7-8640-4ae9-9e20-9e0bafcd2eca",
  "id": "bd8c47ee-e565-4e26-8840-b537e6827b08",
  "name": "test-sfs",
  "network_id": "e72fd98e-32fa-474d-b0a3-bca11c3064ff",
  "network_name": "File_share_test-sfs",
  "project_id": 1337,
  "protocol": "NFS",
  "region": "Luxembourg 1",
  "region_id": 7,
  "share_network_name": "File_share_test-sfs_network",
  "share_settings": {
    "allowed_characters": "NPL",
    "path_length": "LCD",
    "root_squash": true
  },
  "size": 10,
  "subnet_id": "ac601bb9-4d77-4356-96de-66ab29711815",
  "subnet_name": "subnet_test-sfs",
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "task_id": "22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca"
}