Create a volume in a space

v1.0.0

This endpoints creates a new volume in your space (corresponding IBM Containers command: cf ic volume create VOLNAME). A volume is used to persist and access app data between container restarts. Volumes are hosted on file shares that define the available actual storage in Bluemix and the number of input and output transactions per second (IOPS).

After you have created a volume, you must mount it to a container by using the --volume option in the cf ic run (single containers) or cf ic group create (container groups) command. You can also define the volume as part of the HTTP body and send a request to the POST /containers/create (single containers) or POST /containers/groups (container groups) endpoints.

Note: If you mount multiple containers in a space to the same volume, they share the data in the volume and can access them anytime. When a container is deleted, the associated volume is not removed.

Input

{
  "type": "object",
  "properties": {
    "X-Auth-Project-Id": {
      "type": "string"
    },
    "X-Auth-Token": {
      "type": "string"
    },
    "fsName": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "X-Auth-Project-Id",
    "X-Auth-Token",
    "name"
  ],
  "additionalProperties": false
}

Output

{
  "properties": {
    "fsID": {
      "type": "string",
      "description": " Unique identifier representing the file share on which the volume is hosted. "
    },
    "hostPath": {
      "type": "string",
      "description": "Full path to the mounted volume inside the container."
    },
    "otherSpaceVisibility": {
      "type": "array",
      "description": "List of space IDs in which the volume is visible and can be used by all the single containers and container groups. ",
      "items": {
        "type": "string"
      }
    },
    "spaceGuid": {
      "type": "string",
      "description": "Unique identifier representing the space where the volume got created."
    },
    "volName": {
      "type": "string",
      "description": "The name of the volume."
    }
  }
}