This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /selfService/vSphere/Configs/{ID}
Returns a resource representation of a vSphere Self-Service Backup Portal tenant access configuration with the specified ID.
Request
To get a resource representation of the vSphere Self-Service Backup Portal tenant access configuration, you need to send the GET HTTP request to the URL of the /selfService/vSphere/Configs/{ID} resource:
HTTP Request
or
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
BackupServerUid | URN | ID of the Veeam backup server parent to the access configuration resource, for example: urn:veeam:BackupServer:0874ab95-10e5-4f25-84df-2782ad81f3e5. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the access configuration resource. | True | True |
JobSchedulerType | String | Job scheduling options. Possible values:
| True | True |
AccountType | String | Type of the vSphere Self-Service Backup Portal tenant account. Possible values:
| True | True |
PerUser | Boolean | Defines whether users of the group for which the tenant access configuration is created will have separate quotas on the backup repository and what backup jobs will be available to users. Possible values:
| True | True |
QuotaGb | Long | Size of the storage quota assigned to the tenant (in GB). | True | True |
RepositoryUid | URN | ID of the backup repository on which the storage quota for the tenant is created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4. | True | True |
Name | String | Name of the tenant access configuration, for example: tech\william.fox. | True | True |
Uid | URN | ID of the tenant access configuration resource. | True | True |
UsedQuota | Long | Amount of space on the storage quota consumed by the tenant (in MB). | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /selfService/vSphere/Configs/{ID} resource.
Example
The example below returns an entity representation of the configuration with ID bc9c6d31-42ff-4418-94ce-999c0a3102b8.
Request: GET https://localhost:9398/api/selfService/vSphere/Configs/bc9c6d31-42ff-4418-94ce-999c0a3102b8?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <VSphereSelfServiceConfig Href="https://localhost:9398/api/selfService/vSphere/Configs/bc9c6d31-42ff-4418-94ce-999c0a3102b8?format=Entity" Type="VSphereSelfServiceConfig" Name="qahv1-atyrin1" UID="urn:veeam:VSphereSelfServiceConfig:bc9c6d31-42ff-4418-94ce-999c0a3102b8" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
