Share a volume with another space

v1.0.0

This endpoint provisions an existing volume that was created in one space to another space within the same organization. Single containers and container groups in each space can read and write to the shared volume. The volume remains owned by the original space it was created in, including management and billing. For example, the volume can be deleted from the original space only.

Input

{
  "type": "object",
  "properties": {
    "X-Auth-Project-Id": {
      "type": "string"
    },
    "X-Auth-Token": {
      "type": "string"
    },
    "addSpaces": {
      "type": "array",
      "description": "The name or ID of the space where you want to provision your existing volume. Run `cf spaces` to retrieve the name, or `cf space <space_name> --guid` to retrieve the space ID. ",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string"
    },
    "removeSpaces": {
      "type": "array",
      "description": "The name or ID of the space from which you want to unprovision your existing volume. Run `cf spaces` to retrieve the name, or `cf space <space_name> --guid` to retrieve the space ID.",
      "items": {
        "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."
    }
  }
}