Share Management
All operations require authentication.
List sharesProduction
Returns the ID and name of each share of the service. Set detail to true to get all share properties.
Path parameters
Service name
Query parameters
Get detailed information about each share
If specified, returns only shares with given mount point name
Response
Share access mode
rorwShare creation date
Share description
Share ID
User-defined name used to generate human readable access path for the share
Share name
Share protocol
NFSShare size in GiB
Snapshot ID used to create the share
Share status
availableawaiting_replicationcreatingcreating_from_snapshotdeleteddeletingerrorerror_deletingextendingextending_errorinactivemanage_errormanage_startingmigratingmigrating_toreplication_changerevertingreverting_errorshrinkingshrinking_errorshrinking_possible_data_loss_errorunmanage_errorunmanage_startingunmanagedExample uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/1[2 {3 "accessMode": "ro",4 "createdAt": "2024-01-01T12:00:00Z",5 "description": "string",6 "id": "00000000-0000-0000-0000-000000000000",7 "mountPointName": "string",8 "name": "string",9 "protocol": "NFS",10 "size": 0,11 "snapshotID": "string",12 "status": "available"13 }14]
Get a shareProduction
Returns the share properties, its status and its access mode. To get the paths used to mount the share, list its access paths.
Path parameters
Service name
Share ID
Response
Share access mode
rorwShare creation date
Share description
Share ID
User-defined name used to generate human readable access path for the share
Share name
Share protocol
NFSShare size in GiB
Snapshot ID used to create the share
Share status
availableawaiting_replicationcreatingcreating_from_snapshotdeleteddeletingerrorerror_deletingextendingextending_errorinactivemanage_errormanage_startingmigratingmigrating_toreplication_changerevertingreverting_errorshrinkingshrinking_errorshrinking_possible_data_loss_errorunmanage_errorunmanage_startingunmanagedExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "accessMode": "ro",3 "createdAt": "2024-01-01T12:00:00Z",4 "description": "string",5 "id": "00000000-0000-0000-0000-000000000000",6 "mountPointName": "string",7 "name": "string",8 "protocol": "NFS",9 "size": 0,10 "snapshotID": "string",11 "status": "available"12}
Create a shareProduction
Creates an NFS share, empty or from a manual snapshot, in which case the share must be at least the size of the snapshot. Creation is asynchronous: the share is returned with status creating, follow its status until available. The total size of the shares cannot exceed the service capacity.
Path parameters
Service name
Request body (required)
Share access mode
rorwShare creation date
Share description
Share ID
User-defined name used to generate human readable access path for the share
Share name
Share protocol
NFSShare size in GiB
Snapshot ID used to create the share
Share status
availableawaiting_replicationcreatingcreating_from_snapshotdeleteddeletingerrorerror_deletingextendingextending_errorinactivemanage_errormanage_startingmigratingmigrating_toreplication_changerevertingreverting_errorshrinkingshrinking_errorshrinking_possible_data_loss_errorunmanage_errorunmanage_startingunmanagedResponse
Share access mode
rorwShare creation date
Share description
Share ID
User-defined name used to generate human readable access path for the share
Share name
Share protocol
NFSShare size in GiB
Snapshot ID used to create the share
Share status
availableawaiting_replicationcreatingcreating_from_snapshotdeleteddeletingerrorerror_deletingextendingextending_errorinactivemanage_errormanage_startingmigratingmigrating_toreplication_changerevertingreverting_errorshrinkingshrinking_errorshrinking_possible_data_loss_errorunmanage_errorunmanage_startingunmanagedExample uses serviceName = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "accessMode": "ro",3 "createdAt": "2024-01-01T12:00:00Z",4 "description": "string",5 "id": "00000000-0000-0000-0000-000000000000",6 "mountPointName": "string",7 "name": "string",8 "protocol": "NFS",9 "size": 0,10 "snapshotID": "string",11 "status": "available"12}
Extend a shareProduction
Increases the share to the given size in GB, which must be greater than its current size. The share must be available, and the change is asynchronous: its status moves to extending, then back to available, or to extending_error if it fails.
Path parameters
Service name
Share ID
Request body (required)
Share size in GiB
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/Shrink a shareProduction
Reduces the share to the given size in GB, which must be smaller than its current size. The share must be available, and the change is asynchronous: follow the share status until it is available again. If the new size is smaller than the space already used, the share keeps its current size.
Path parameters
Service name
Share ID
Request body (required)
Share size in GiB
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/Update a shareProduction
Updates the share name and description. To change the size, use Extend a share or Shrink a share.
Path parameters
Service name
Share ID
Request body (required)
New share description
New share name
Response
Share access mode
rorwShare creation date
Share description
Share ID
User-defined name used to generate human readable access path for the share
Share name
Share protocol
NFSShare size in GiB
Snapshot ID used to create the share
Share status
availableawaiting_replicationcreatingcreating_from_snapshotdeleteddeletingerrorerror_deletingextendingextending_errorinactivemanage_errormanage_startingmigratingmigrating_toreplication_changerevertingreverting_errorshrinkingshrinking_errorshrinking_possible_data_loss_errorunmanage_errorunmanage_startingunmanagedExample uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/1{2 "accessMode": "ro",3 "createdAt": "2024-01-01T12:00:00Z",4 "description": "string",5 "id": "00000000-0000-0000-0000-000000000000",6 "mountPointName": "string",7 "name": "string",8 "protocol": "NFS",9 "size": 0,10 "snapshotID": "string",11 "status": "available"12}
Delete a shareProduction
Permanently deletes the share and its ACLs. Deletion is asynchronous. Delete the snapshots and replications of the share first.
Path parameters
Service name
Share ID
Response
Example uses serviceName = 00000000-0000-0000-0000-000000000000, shareId = 00000000-0000-0000-0000-000000000000
$ curl https:/