GET /query?type=VsphereSelfServiceConfig
Returns a resource representation of a collection of vSphere Self-Service Backup Portal tenant access configurations. For details, see /selfService/vSphere/Configs.
Request
To get a list of vSphere Self-Service Backup Portal tenant access configurations, send the GET HTTP request to the query with the type parameter set to VsphereSelfServiceConfig.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=VsphereSelfServiceConfig |
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. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values: - application/xml — the client can send this value in the header to accept response in the XML format.
- application/json — the client must send this value in the header to accept the request in the JSON format.
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
Parameter | Type | Description |
|---|
UID | UidType | UID of the tenant access configuration resource. |
Name | String | Name of the tenant access configuration, for example: tech\william.fox. |
BackupServerUid | UidType | UID of the backup server parent to the access configuration resource, for example: urn:veeam:BackupServer:0874ab95-10e5-4f25-84df-2782ad81f3e5. |
BackupServerName | String | Name of the backup server parent to the access configuration resource. |
JobSchedulerType | String | Job scheduling options. Possible values: - Full — tenant of the vSphere Self-Service Backup Portal has full access to all job scheduling options.
- Partial — tenant of the vSphere Self-Service Backup Portal can create daily and monthly jobs only.
- Random — tenant of the vSphere Self-Service Backup Portal can create daily jobs with randomized start time within the backup window.
- Disabled — tenant of the vSphere Self-Service Backup Portal can create only jobs with no schedule assigned.
|
AccountType | String | Type of the vSphere Self-Service Backup Portal tenant account. Possible values: - User — tenant account is a user account.
- Group — tenant account is a group account.
|
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 — each user of the group has a separate quota on the backup repository. Each user has access to backup jobs created by this user only.
- False — all users of the group share the same quota on the backup repository. Each user has access to all backup jobs created by users of the group.
|
QuotaGb | Long | Size of the storage quota assigned to the tenant (in GB). |
RepositoryUid | UidType | UID of the backup repository on which the storage quota for the tenant is created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4. |
UsedQuota | Long | Amount of space on the storage quota consumed by the tenant (in MB). |
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: - application/xml
- application/json
|
Response Body
In the response body, the REST API returns a representation of the /selfService/vSphere/Configs resource collection.
Example
The example below returns an entity resource representation of a collection of vSphere Self-Service Backup Portal tenant access configurations created for Group accounts on the enterprise06.tech.local backup server. The results are ordered in the acceding order by the Name parameter.
Request: GET https://localhost:9398/api/query?type=VSphereSelfServiceConfig&format=Entities&sortAsc=Name&filter=BackupServerName=="enterprise06.tech.local";AccountType==Group Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0">
<Entities>
<VSphereSelfServiceConfigs>
<VSphereSelfServiceConfig Type="VSphereSelfServiceConfig" Href="https://localhost:9398/api/selfService/vSphere/Configs/c6a041d0-36a1-47c7-9f4b-a12327796c68?format=Entity" Name="Administrators" UID="urn:veeam:VSphereSelfServiceConfig:c6a041d0-36a1-47c7-9f4b-a12327796c68">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" />
<Link Rel="Alternate" Type="VSphereSelfServiceConfigReference" Href="https://localhost:9398/api/selfService/vSphere/Configs/c6a041d0-36a1-47c7-9f4b-a12327796c68" Name="Administrators" />
<Link Rel="Edit" Type="VSphereSelfServiceConfigReference" Href="https://localhost:9398/api/selfService/vSphere/Configs/c6a041d0-36a1-47c7-9f4b-a12327796c68" Name="Administrators" />
<Link Rel="Delete" Href="https://localhost:9398/api/selfService/vSphere/Configs/c6a041d0-36a1-47c7-9f4b-a12327796c68" />
<Link Rel="Down" Type="VSphereSelfServiceConfigJobSettings" Href="https://localhost:9398/api/selfService/vSphere/Configs/c6a041d0-36a1-47c7-9f4b-a12327796c68/backupJobSettings" Name="Administrators" />
</Links>
<BackupServerUid>urn:veeam:BackupServer:7445e6ce-86f5-4171-b909-dac209c66563</BackupServerUid>
<RepositoryUid>urn:veeam:Repository:425b6739-5082-4f7a-99fb-1ae13ef87d9f</RepositoryUid>
<QuotaGb>500</QuotaGb>
<PerUser>false</PerUser>
<Account>
<AccountName>Administrators</AccountName>
<AccountSid>S-1-5-32-544</AccountSid>
<AccountType>Group</AccountType>
</Account>
<JobSettings>
<DefaultSettings>false</DefaultSettings>
<JobSchedulerType>Full</JobSchedulerType>
<HighPriorityJob>true</HighPriorityJob>
</JobSettings>
<VCentersScope>
<VCenterUid>urn:veeam:ManagedServer:6edb23da-560b-4759-951f-1da6aca08169</VCenterUid>
<VCenterUid>urn:veeam:ManagedServer:095585e0-6a9a-4bb8-8433-a1d815687ce9</VCenterUid>
</VCentersScope>
<Tags />
<UsedQuotaMb>0</UsedQuotaMb>
</VSphereSelfServiceConfig>
<VSphereSelfServiceConfig Type="VSphereSelfServiceConfig" Href="https://localhost:9398/api/selfService/vSphere/Configs/a6ca480a-e7eb-4524-939e-bba8c7587d0e?format=Entity" Name="Domain Users" UID="urn:veeam:VSphereSelfServiceConfig:a6ca480a-e7eb-4524-939e-bba8c7587d0e">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" />
<Link Rel="Alternate" Type="VSphereSelfServiceConfigReference" Href="https://localhost:9398/api/selfService/vSphere/Configs/a6ca480a-e7eb-4524-939e-bba8c7587d0e" Name="Domain Users" />
<Link Rel="Edit" Type="VSphereSelfServiceConfigReference" Href="https://localhost:9398/api/selfService/vSphere/Configs/a6ca480a-e7eb-4524-939e-bba8c7587d0e" Name="Domain Users" />
<Link Rel="Delete" Href="https://localhost:9398/api/selfService/vSphere/Configs/a6ca480a-e7eb-4524-939e-bba8c7587d0e" />
<Link Rel="Down" Type="VSphereSelfServiceConfigJobSettings" Href="https://localhost:9398/api/selfService/vSphere/Configs/a6ca480a-e7eb-4524-939e-bba8c7587d0e/backupJobSettings" Name="Domain Users" />
</Links>
<BackupServerUid>urn:veeam:BackupServer:7445e6ce-86f5-4171-b909-dac209c66563</BackupServerUid>
<RepositoryUid>urn:veeam:Repository:425b6739-5082-4f7a-99fb-1ae13ef87d9f</RepositoryUid>
<QuotaGb>30</QuotaGb>
<PerUser>true</PerUser>
<Account>
<AccountName>Domain Users</AccountName>
<AccountSid>S-1-5-21-4081262488-3246261347-3296280108-513</AccountSid>
<AccountType>Group</AccountType>
</Account>
<JobSettings>
<DefaultSettings>true</DefaultSettings>
<JobSchedulerType>Full</JobSchedulerType>
<HighPriorityJob>false</HighPriorityJob>
</JobSettings>
<VCentersScope />
<Tags />
<UsedQuotaMb>0</UsedQuotaMb>
</VSphereSelfServiceConfig>
</VSphereSelfServiceConfigs>
</Entities>
<PagingInfo PagesCount="1" PageSize="100" PageNum="1">
<Links>
<Link Rel="First" Href="https://localhost:9398/api/query?type=VSphereSelfServiceConfig&format=Entities&sortAsc=Name&filter=BackupServerName=="enterprise06.tech.local";AccountType==Group&pageSize=100&page=1" />
<Link Rel="Last" Href="https://localhost:9398/api/query?type=VSphereSelfServiceConfig&format=Entities&sortAsc=Name&filter=BackupServerName=="enterprise06.tech.local";AccountType==Group&pageSize=100&page=1" />
</Links>
</PagingInfo>
</QueryResult> |