GET Backup Content (Namespace View) REST API Operation

Use this operation to browse the cluster environment for application group content.

The following browse views are available:

Applications: Lists the namespaces that can be drilled down to get applications.
Volumes: Lists the namespaces that can be drilled down to get volumes.
Labels: Lists the namespaces that can be drilled down to get labels.

Request

Syntax

GET webservice/VMBrowse?inventoryPath=%5CFOLDER%3AbrowseView%3AbrowseView&PseudoClientId=clientId HTTP/1.1
Host: host name
Accept: application/xml or application/json
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
browseView	The browse tree to identify. Valid values are Applications, Volumes, and Labels.	Yes
clientId	The ID for the Kubernetes cluster client. If the client ID is not known, use the GET Kubernetes Client ID API to retrieve it.	Yes

Name

Description

Required

browseView

The browse tree to identify.

Valid values are Applications, Volumes, and Labels.

Yes

clientId

The ID for the Kubernetes cluster client.

If the client ID is not known, use the GET Kubernetes Client ID API to retrieve it.

Yes

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are application/xml and application/json.
Authtoken	The authentication token received after successfully logging on. For information about receiving an authentication token, see Authentication.

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

The format of the response.

Valid values are application/xml and application/json.

Authtoken

The authentication token received after successfully logging on.

For information about receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
name	The name of the entity.	inventoryInfo
templateVM	Indicates if the entity is a VM. Valid value is 0.	inventoryInfo
maintenanceMode	Indicates if the entity is in maintenance mode. Valid value is 0.	inventoryInfo
type	The type of application. Valid values are: FOLDER, for namespace. VM, for application. Selector, for selector. Folder, for labels. VM, for volumes.	inventoryInfo
strGUID	The GUID value for the application. It is a unique identifier for the Kubernetes entity.	inventoryInfo
poweredOff	Indicates if the application is powered off. Valid value is 1.	inventoryInfo
toolStatus	Indicates the status of the tool. Valid value is 0.	InventoryInfo

Examples

Sample Request

webservice/VMBrowse?inventoryPath=%5CFOLDER%3AApplications%3AApplications&PseudoClientId=13

Sample Response

<EVGui_BrowseInventory> <inventoryInfo path="" name="default" templateVM="0" maintenanceMode="0" type="5" strGUID="default`Namespace`default`eb0ce0a5-daa5-4e02-9bdc-94259a31b9d4" poweredOff="1" toolsStatus="0" /> <inventoryInfo path="" name="rook-ceph" templateVM="0" maintenanceMode="0" type="5" strGUID="default`Namespace`rook-ceph`e641faa8-fef4-49ff-b5be-da44d2ccf931" poweredOff="1" toolsStatus="0" />
</EVGui_BrowseInventory>