# Hypervisor Storage Controller Resource

The API allows you to view, list, create and edit hypervisor storages.

### GET /hypervisor-storages

Returns list of hypervisor storages filtered by specified query parameters.

Request Parameters
name | type | description | constraints | multivalued
--- | --- | --- | --- | ---
backupFileGuid | query |  |  | no
cluster | query |  |  | no
cluster-uuid | query |  |  | no
direction | query |  |  | no
filter | query |  |  | no
hvm-type | query |  | "AWS" or "AZURE" or "FAKE_HVM" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "NUTANIX_V4" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "PLATFORM9" or "RHEV" or "RHV" or "VCENTER" or "VERGE" or "VIRTUOZZO" or "ZADARA" | yes
hypervisor | query |  |  | no
hypervisor-manager | query |  |  | no
nameLike | query |  |  | no
nfs-storage | query |  | boolean | no
orderBy | query |  |  | no
page | query |  |  | no
project-uuid | query |  |  | no
size | query |  |  | no
storage-pool-name | query |  |  | no
uuid | query |  |  | no

Response Body
media type | data type | description
--- | --- | ---
application/json | array of HypervisorStorageListRecord (JSON) | list of hypervisor storages filtered by specified query parameters

#### Example

##### Request

    GET /hypervisor-storages
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ { } ]

### POST /hypervisor-storages

Create a hypervisor storage.

Request Body
media type | data type | description
--- | --- | ---
application/json | HypervisorStorageRequest (JSON) | specify details for new hypervisor storage

Response Body
media type | data type | description
--- | --- | ---
application/json | HypervisorStorageRecordExtendedDetail (JSON) | details of newly created hypervisor storage

#### Example

##### Request

    POST /hypervisor-storages
    Content-Type: application/json
    Accept: application/json

    { }

##### Response

    HTTP/1.1 201 Created
    Content-Type: application/json

    { }

### GET /hypervisor-storages/detailed

Returns detailed list of hypervisor storages filtered by specified query parameters.

Request Parameters
name | type | description | constraints | multivalued
--- | --- | --- | --- | ---
backupFileGuid | query |  |  | no
cluster | query |  |  | no
cluster-uuid | query |  |  | no
direction | query |  |  | no
filter | query |  |  | no
hvm-type | query |  | "AWS" or "AZURE" or "FAKE_HVM" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "NUTANIX_V4" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "PLATFORM9" or "RHEV" or "RHV" or "VCENTER" or "VERGE" or "VIRTUOZZO" or "ZADARA" | yes
hypervisor | query |  |  | no
hypervisor-manager | query |  |  | no
nameLike | query |  |  | no
nfs-storage | query |  | boolean | no
orderBy | query |  |  | no
page | query |  |  | no
project-uuid | query |  |  | no
size | query |  |  | no
storage-pool-name | query |  |  | no
uuid | query |  |  | no

Response Body
media type | data type | description
--- | --- | ---
application/json | array of HypervisorStorageRecordExtendedDetail (JSON) | detailed list of hypervisor storages filtered by specified query parameters

#### Example

##### Request

    GET /hypervisor-storages/detailed
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ { } ]

### GET /hypervisor-storages/for-restore

Returns list of hypervisor storage for restore infos filtered by specified query parameters.

Request Parameters
name | type | description | constraints | multivalued
--- | --- | --- | --- | ---
backupFileGuid | query |  |  | no
cluster | query |  |  | no
cluster-uuid | query |  |  | no
direction | query |  |  | no
filter | query |  |  | no
hvm-type | query |  | "AWS" or "AZURE" or "FAKE_HVM" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "NUTANIX_V4" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "PLATFORM9" or "RHEV" or "RHV" or "VCENTER" or "VERGE" or "VIRTUOZZO" or "ZADARA" | yes
hypervisor | query |  |  | no
hypervisor-manager | query |  |  | no
nameLike | query |  |  | no
nfs-storage | query |  | boolean | no
orderBy | query |  |  | no
page | query |  |  | no
project-uuid | query |  |  | no
size | query |  |  | no
storage-pool-name | query |  |  | no
uuid | query |  |  | no

Response Body
media type | data type | description
--- | --- | ---
application/json | array of HypervisorStorageForRestoreListRecord (JSON) | list of list of hypervisor storage for restore infos filtered by specified query parameters

#### Example

##### Request

    GET /hypervisor-storages/for-restore
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ { } ]

### GET /hypervisor-storages/query

Returns list of hypervisor storages filtered by specified query parameters.

Request Parameters
name | type | description | constraints | multivalued
--- | --- | --- | --- | ---
backupFileGuid | query |  |  | no
cluster | query |  |  | no
cluster-uuid | query |  |  | no
direction | query |  |  | no
filter | query |  |  | no
hvm-type | query |  | "AWS" or "AZURE" or "FAKE_HVM" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "NUTANIX_V4" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "PLATFORM9" or "RHEV" or "RHV" or "VCENTER" or "VERGE" or "VIRTUOZZO" or "ZADARA" | yes
hypervisor | query |  |  | no
hypervisor-manager | query |  |  | no
nameLike | query |  |  | no
nfs-storage | query |  | boolean | no
orderBy | query |  |  | no
page | query |  |  | no
project-uuid | query |  |  | no
size | query |  |  | no
storage-pool-name | query |  |  | no
uuid | query |  |  | no

Response Body
media type | data type | description
--- | --- | ---
application/json | array of HypervisorStorageListRecord (JSON) | list of hypervisor storages filtered by specified query parameters

#### Example

##### Request

    GET /hypervisor-storages/query
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ { } ]

### DELETE /hypervisor-storages/{guid}

Remove hypervisor storage.

Request Parameters
name | type | description
--- | --- | ---
guid | path | specify local unique identifier for hypervisor storage (use by vProtect)

#### Example

##### Request

    DELETE /hypervisor-storages/{guid}
    Content-Type: */*

    ...

##### Response

    HTTP/1.1 204 No Content

### GET /hypervisor-storages/{guid}

Get a single hypervisor storage.

Request Parameters
name | type | description
--- | --- | ---
guid | path | specify local unique identifier for hypervisor storage (use by vProtect)

Response Body
media type | data type | description
--- | --- | ---
application/json | HypervisorStorageRecordExtendedDetail (JSON) | hypervisor storage details

#### Example

##### Request

    GET /hypervisor-storages/{guid}
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    { }

### PUT /hypervisor-storages/{guid}

Change hypervisor storage details.

Request Parameters
name | type | description
--- | --- | ---
guid | path | specify local unique identifier for hypervisor storage (use by vProtect)

Request Body
media type | data type | description
--- | --- | ---
application/json | HypervisorStorageUpdate (JSON) | specify hypervisor storage details to update

Response Body
media type | data type | description
--- | --- | ---
application/json | HypervisorStorageRecordExtendedDetail (JSON) | updated details of hypervisor storage

#### Example

##### Request

    PUT /hypervisor-storages/{guid}
    Content-Type: application/json
    Accept: application/json

    { }

##### Response

    HTTP/1.1 204 No Content
    Content-Type: application/json

    { }

### GET /hypervisor-storages/query/detailed

Returns list of hypervisor storages filtered by specified query parameters.

Request Parameters
name | type | description | constraints | multivalued
--- | --- | --- | --- | ---
backupFileGuid | query |  |  | no
cluster | query |  |  | no
cluster-uuid | query |  |  | no
direction | query |  |  | no
filter | query |  |  | no
hvm-type | query |  | "AWS" or "AZURE" or "FAKE_HVM" or "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "NUTANIX_V4" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "PLATFORM9" or "RHEV" or "RHV" or "VCENTER" or "VERGE" or "VIRTUOZZO" or "ZADARA" | yes
hypervisor | query |  |  | no
hypervisor-manager | query |  |  | no
nameLike | query |  |  | no
nfs-storage | query |  | boolean | no
orderBy | query |  |  | no
page | query |  |  | no
project-uuid | query |  |  | no
size | query |  |  | no
storage-pool-name | query |  |  | no
uuid | query |  |  | no

Response Body
media type | data type | description
--- | --- | ---
application/json | array of HypervisorStorageRecordExtendedDetail (JSON) | list of hypervisor storages filtered by specified query parameters

#### Example

##### Request

    GET /hypervisor-storages/query/detailed
    Content-Type: */*
    Accept: application/json

    ...

##### Response

    HTTP/1.1 200 OK
    Content-Type: application/json

    [ { } ]