# Network Controller Resource

The API allows you list and view networks.

### GET /network

Returns list of networks filtered by specified query parameters.

Request Parameters
name | type | description | constraints
--- | --- | --- | ---
compute-region | query |  |
dataCenter | query |  |
direction | query |  |
filter | query |  |
hvCluster | query |  |
hypervisor | query |  |
hypervisor-manager | query |  |
hypervisor-manager-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"
hypervisor-type | query |  | "CITRIX" or "ESXI" or "FAKE_HV" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "VERGE" or "XEN"
nameLike | query |  |
orderBy | query |  |
page | query |  |
present | query |  | boolean
project | query |  |
project-uuid | query |  |
size | query |  |

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

#### Example

##### Request

    GET /network
    Content-Type: */*
    Accept: application/json

    ...

##### Response

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

    [ { } ]

### GET /network/for-restore

Returns list of networks for restore filtered by specified query parameters.

Request Parameters
name | type | description | constraints
--- | --- | --- | ---
compute-region | query |  |
dataCenter | query |  |
direction | query |  |
filter | query |  |
hvCluster | query |  |
hypervisor | query |  |
hypervisor-manager | query |  |
hypervisor-manager-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"
hypervisor-type | query |  | "CITRIX" or "ESXI" or "FAKE_HV" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "VERGE" or "XEN"
nameLike | query |  |
orderBy | query |  |
page | query |  |
present | query |  | boolean
project | query |  |
project-uuid | query |  |
size | query |  |

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

#### Example

##### Request

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

    ...

##### Response

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

    [ { } ]

### GET /network/shared

Returns list of shared networks filtered by specified query parameters.

Request Parameters
name | type | description | constraints
--- | --- | --- | ---
compute-region | query |  |
dataCenter | query |  |
direction | query |  |
filter | query |  |
hvCluster | query |  |
hypervisor | query |  |
hypervisor-manager | query |  |
hypervisor-manager-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"
hypervisor-type | query |  | "CITRIX" or "ESXI" or "FAKE_HV" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "VERGE" or "XEN"
nameLike | query |  |
orderBy | query |  |
page | query |  |
present | query |  | boolean
project | query |  |
project-uuid | query |  |
size | query |  |

Response Body
media type | data type | description
--- | --- | ---
application/json | array of NetworkDetails (JSON) | list of shared networks filtered by specified query parameters

#### Example

##### Request

    GET /network/shared
    Content-Type: */*
    Accept: application/json

    ...

##### Response

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

    [ { } ]

### DELETE /network/{guid}

Request Parameters
name | type | description
--- | --- | ---
guid | path |

#### Example

##### Request

    DELETE /network/{guid}
    Content-Type: */*

    ...

##### Response

    HTTP/1.1 204 No Content

### GET /network/{guid}

Get a single network.

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

Response Body
media type | data type | description
--- | --- | ---
application/json | NetworkDetails (JSON) | network details

#### Example

##### Request

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

    ...

##### Response

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

    { }