Volumes API

/v1/volumes retrieves information about all volumes in the site processing the API.

URL

Information about all volumes	https://zvm_ip:port/v1/volumes
To get list of volumes info of current site	https://zvm_ip:port/v1/volumes?volumeType={volumeType}&vpgIdentifier={vpgIdentifier}&datastoreIdentifier={datastoreIdentifier}&protectedVmIdentifier={protectedVmIdentifier}&owningVmIdentifier={owningVmIdentifier}

Where:

zvm_ip	The IP address of the Zerto Virtual Manager where the API is run.
port	The port to access the Zerto Virtual Manager. The default port is 9669.
Filters	Filters are optional and any combination of filters is valid. When no filter is specified, all volumes are returned. Filters are not case-sensitive.
	Filter	Description
	volumeType	The type of volume. Possible values are: 0 or Protected 1 or Recovery 2 or Journal 3 or Scratch 6 or Appliances 10 or Unknown
	vpgIdentifier
	datastoreIdentifier
	protectedVmIdentifier	The identifier of the protected virtual machine.
	owningVmIdentifier	The identifier of the owning virtual machine.

HTTP Method

GET

Security

The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.

See Also

Starting a session: Session: POST

Format

Json, XML

Request Body Using Json Format

The request body is empty.

Response In Json Format

The following is an example response Json body for https://zvm_ip:port/v1/volumes.

[
 {
  "Datastore" 
    "Identifier": "string content",
    "Name": "string content",
  }
  "IsThisProvisioned": Boolean,
  "OwningVM":{
    Identifier": "string content",
    "Name": "string content",
  }
  "Path": {
    "FileName": "Normal",
    "Full": 7,
    "Relative": 0,
  }
  "ProtectedVm": {
    Identifier": "string content",
    "Name": "string content",
  }
  "Size": {
    "ProvisionedInBytes": 33570816,
    "UsedInBytes: 415236096
  }
  "VolumeType": "Journal",
  "Vpg": {
    Identifier": "string content",
    "Name": "string content",
  ]
 {

Response values for https://zvm_ip:port/v1/volumes.

Parameter	Description
Datastore
Identifier	The identifier of the datastore.
Name	The name of the datastore.
IsThinProvisioned	True: The recovery volumes are thin-provisioned. False: The recovery volumes are thick-provisioned.
OwningVm
Identifier	The identifier of the owning virtual machine.
Name	The name of the owning virtual machine.
Path
FileName	The file name of the .VMDK.
Full	The full path of the .VMDK.
Relative	The relative path of the .VMDK.
ProtectedVm
Identifier	The identifier of the protected virtual machine.
Name	The name of the protected virtual machine.
Size
ProvisionedInBytes	The provisioned size of the volume, in bytes.
UsedInBytes	The used size of the volume, in bytes.
VolumeType	The type of volume. Possible values are: 0 or Protected 1 or Recovery 2 or Journal 3 or Scratch 6 or Appliances 10 or Unknown
Vpg
Identifier	The identifier of the owning VPG.
Name	The name of the owning VPG.