v1

Volumes

Retrieve detailed information about a volume.

Retrieve a detailed list of information about a volume that is identified by the volume name (corresponding IBM Containers command: cf ic volume inspect VOLNAME).

get/volumes/{name}/json

Path parameters

namestring required

The name of the volume, for which you want to retrieve detailed information. Run cf ic volume list or call the GET /volumes/json endpoint to retrieve a list of all volumes that are available in your space.

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 with detailed information about the volume is returned.

fsIDstring

Unique identifier representing the file share on which the volume is hosted.

hostPathstring

Full path to the mounted volume inside the container.

otherSpaceVisibilitystring[]

List of space IDs in which the volume is visible and can be used by all the single containers and container groups.

spaceGuidstring

Unique identifier representing the space where the volume got created.

volNamestring

The name of the volume.