Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(POST) /selfService/vSphere/Configs

Creates a vSphere Self-Service Backup Portal tenant access configuration.

Request

To create a vSphere Self-Service Backup Portal tenant access configuration, you need to send the POST HTTP request to the URL of the /selfService/vSphere/Configs resource.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/selfService/vSphere/Configs

Request Header

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

The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body

In the request body, the client must send parameters of the vSphere Self-Service Backup Portal tenant access configuration. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager RESTful API.

The request body must contain the following elements:

Element

Type

Description

Modifiable

Min/Max Occurrence

AccountName

String

Name of the vSphere tenant account user or group for which configuration is created. The vSphere tenant account must be created in advance on a vSphere server processed by a Veeam backup server added to Veeam Backup Enterprise Manager.

Yes

1/1

RepositoryUid

URN

ID of the backup repository on which the storage quota for the vSphere tenant must be created, for example: urn:veeam:Repository:893d2ecc-879a-4f2a-8a31-3594t7cr1ya4.

You cannot assign cloud-based repositories, as well as NetApp or Nimble storage systems storing snapshots created by Veeam snapshot-only jobs.

Yes

1/1

QuotaGb

Long

Size of the storage quota assigned to the vSphere tenant (in GB).

Yes

1/1

PerUser

Boolean

If set to True, users of the tenant account group will be able to observe only their respective jobs. If set to False, users of the tenant account group will see each others jobs as well.

Yes

0/1

TemplateJobUid

URN

ID of the VMware backup job that will be used as a template for vSphere tenant users VMs processing. The backup job must be created in advance on the Veeam backup server connected to Veeam Backup Enterprise Manager.

Settings of the specified job will be applied to backup jobs created by tenant-side users. If the job ID is not specified, tenant-side jobs will be configured with the default vSphere backup job settings.

Job settings applied to backup jobs for the vSphere organization will be listed in the representation of the /selfService/vSphere/Configs/{ID}/backupJobSettings resource.

Yes

0/1

JobSchedulerType

String

Job scheduling options. Possible values:

  • FullvSphere tenant user has full access to all job scheduling options.
  • PartialvSphere tenant user can create daily and monthly jobs only.
  • RandomvSphere tenant user can create daily jobs with randomized start time within the backup window.
  • DisabledvSphere tenant user can create only jobs with no schedule assigned.

Yes

1/1

Tags

TagsListType

List of tags for the vSphere Tags mode in Delegation Mode. For more information, see Tags.

Yes

0/1

For example:

<?xml version="1.0" encoding="utf-8"?>

<VSphereSelfServiceCreateSpec 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">
 <AccountName/>
 <RepositoryUid>urn:veeam:Repository:00000000-0000-0000-0000-000000000000</RepositoryUid>
 <QuotaGb>10</QuotaGb>
 <PerUser>false</PerUser>
 <TemplateJobUid>urn:veeam:Job:00000000-0000-0000-0000-000000000000</TemplateJobUid>
 <JobSchedulerType>Full</JobSchedulerType>
 <Tags/>
</VSphereSelfServiceCreateSpec>

vSphere Tags

You can define the following parameters for vSphere Delegation Mode Tags:

Element

Type

Description

Modifiable

Min/Max Occurrence

Tag

String

vSphere Delegation Mode Tags.

Yes

0/-

For example:

<Tags/>
 <Tag/>RestAPITag<Tag/>
 <Tags/>

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 202 Accepted.

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

None.

Example

The example below creates a new configuration for the vSphere tenant user with the name support.north. The storage quota of 100 GB is created on the backup repository that has ID df9903aa-d2b6-4edd-9a0b-057bc8dd4451. The backup job with ID 6c6ab2af-df49-4112-a036-72cf9bd28fef is used as a template for tenant-side backup jobs. The vSphere tenant user has full access to all job scheduling options.

Request:

POST http://localhost:9399/api/selfService/vSphere/Configs

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<VSphereSelfServiceCreateSpec 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">
 <AccountName>support.north</AccountName>
 <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>100</QuotaGb>
 <PerUser>false</PerUser>
 <TemplateJobUid>urn:veeam:Job:24f70e27-549a-4126-bfe5-167cca158a0f</TemplateJobUid>
 <TemplateMode>Default</TemplateMode>
 <JobSchedulerType>Full</JobSchedulerType>
 <Tags>
 <Tag>RestAPITag<Tag/>
 <Tags/>
</VSphereSelfServiceCreateSpec>

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>CreateVSphereSelfServiceConfig</Operation>
</Task>

To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

Request:

GET http://localhost:9399/api/tasks/task-1

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<Task 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" Href="http://support.north.local:9399/api/tasks/task-1" Type="Task">
 <Links>
   <Link Href="http://localhost:9399/api/tasks/task-1" Rel="Delete"/>
   <Link Href="http://localhost:9399/api/selfService/vSphere/Configs/9525996c-2e11-4ece-9d0b-41d4fda59fd7" Name="support.north" Type="VSphereSelfServiceConfigReference" Rel="Related"/>
 </Links>
 <TaskId>task-311</TaskId>
 <State>Finished</State>
 <Operation>CreateVSphereSelfServiceConfig</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation