The API allows you list and view networks.
Returns list of networks filtered by specified query 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 "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" | |
hypervisor-type | query | "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" | |
nameLike | query | ||
orderBy | query | ||
page | query | ||
present | query | boolean | |
project | query | ||
project-uuid | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of NetworkDetails (JSON) | list of networks filtered by specified query parameters |
GET /network
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"present" : true,
"networkInterfaceCards" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"hypervisorManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
} ]
Returns list of networks for restore filtered by specified query 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 "FUSIONCOMPUTE" or "GCP" or "HC3" or "HYPERV" or "KUBERNETES" or "NUTANIX" or "OPENNEBULA" or "OPENSHIFT" or "OPENSTACK" or "ORACLE" or "RHEV" or "RHV" or "VCENTER" or "VIRTUOZZO" | |
hypervisor-type | query | "CITRIX" or "ESXI" or "HYPERV" or "KUBERNETES" or "KVM" or "NUTANIX" or "OPENSHIFT" or "OVM" or "PROXMOX" or "XEN" | |
nameLike | query | ||
orderBy | query | ||
page | query | ||
present | query | boolean | |
project | query | ||
project-uuid | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of NetworkDetails (JSON) | list of networks filtered by specified query parameters |
GET /network/for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"present" : true,
"networkInterfaceCards" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"hypervisorManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
} ]
name | type | description |
---|---|---|
guid | path |
DELETE /network/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single network.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for network (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | NetworkDetails (JSON) | network details |
GET /network/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"present" : true,
"networkInterfaceCards" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"hypervisorManager" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hypervisor" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projects" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"dataCenter" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hvCluster" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}