Sign in

v1

latestOpenAPI 3.0.0(C) Copyright IBM Corp. 2016 All Rights Reserved.2026-07-144737155.4 KB
File shares

List available file shares in a space

This endpoint returns a list of all file shares that are availble in a space (corresponding IBM Containers command: cf ic volume fs-list).

get/volumes/fs/json

Headers

X-Auth-Tokenstring required

The Bluemix JSON web token that you receive when logging into Bluemix. Run cf oauth-token to retrieve your access token.

X-Auth-Project-Idstring required

The unique ID of your organization space where you want to create or work with your containers. Run cf space <space_name> --guid, where <space_name> is the name of your space, to retrieve your space ID.

Response

OK. A list of available file shares is returned.

capacityinteger

The size of the file share in gigabyte.

created_datestring

The timestamp when the file share was created.

fsNamestring

The name of the file share.

hostPathstring

The path to the volume on the host node.

iopsnumber double

The number of Input/Output operations per second.

iopsTotalinteger

The total number of IOPS considering the size of the file share. The size of your file share in gigabyte multiplied with the number of IOPS indicates the total number of IOPS. The higher the number of IOPS the faster you can read from and write to your volumes.

orderIdstring

The ID received from softlayer when the file share was ordered to be set up in softlayer.

providerstring

The provider of the file share.

spaceGuidstring

The unique ID representing a Bluemix space in which the file share was created.

statestring

The current state of the file share. When the file share is ready to be used, this attribute is set to READY.

updated_datestring

The timestamp when the file share last was updated.