Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(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 https://<Enterprise-Manager>:9398/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.

Content-Type

True

Identifies the format of the request body message. Possible values:

  • application/xml
  • application/json

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

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 user or group account for which the tenant access configuration is created. The account must be created in advance on a vCenter 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 tenant of vSphere Self-Service Backup Portal must be created, for example: urn:veeam:Repository:893d2ecc-879a-4f2a-8a31-3594t7cr1ya4.

You cannot assign to tenants quotas on cloud repositories, as well as NetApp or Nimble storage systems that store snapshots created by Veeam snapshot-only jobs.

Yes

1/1

QuotaGb

Long

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

Yes

1/1

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.

Yes

0/1

TemplateJobUid

URN

ID of the backup job that will be used as a template for backup jobs created by the tenant of vSphere Self-Service Backup Portal. 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 the tenant. If the job ID is not specified, tenant jobs will be configured with the default vSphere backup job settings.

Settings applied to backup jobs of the tenant will be displayed in the representation of the /selfService/vSphere/Configs/{ID}/backupJobSettings resource.

Yes

0/1

JobSchedulerType

String

Job scheduling options. Possible values:

  • Fulltenant of the vSphere Self-Service Backup Portal has full access to all job scheduling options.
  • Partialtenant of the vSphere Self-Service Backup Portal can create daily and monthly jobs only.
  • Randomtenant of the vSphere Self-Service Backup Portal can create daily jobs with randomized start time within the backup window.
  • Disabledtenant of the vSphere Self-Service Backup Portal can create only jobs with no schedule assigned.

Yes

1/1

Tags

TagsListType

vSphere tags that define what VMs will be available to the tenant. For more information, see vSphere Tags.

vSphere tags must be specified if the vSphere tags delegation mode is selected in Veeam Backup Enterprise Manager.

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:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>10</QuotaGb>
 <PerUser>false</PerUser>
 <TemplateJobUid>urn:veeam:Job:24f70e27-549a-4126-bfe5-167cca158a0f</TemplateJobUid>
 <JobSchedulerType>Full</JobSchedulerType>
 <Tags/>
</VSphereSelfServiceCreateSpec>

vSphere Tags

If the vSphere tags delegation mode is selected in Veeam Backup Enterprise Manager, you must specify tags in the tenant access configuration. The tenant will be able to back up only those VMs to which the specified tags are assigned.

The request body must contain the following elements:

Element

Type

Description

Modifiable

Min/Max Occurrence

Tag

String

vSphere tag assigned to a VM that must be available to the tenant.

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 tenant access configuration for the vSphere user with the name tech\william.fox. 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 24f70e27-549a-4126-bfe5-167cca158a0f is used as a template for backup jobs created by the tenant of the vSphere Self-Service Backup Portal. The tenant has full access to all job scheduling options.

Request:

POST https://localhost:9398/api/selfService/vSphere/Configs

 

Request Headers:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Content-Type         application/xml

 

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>tech\william.fox</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="https://localhost:9398/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="https://localhost:9398/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 https://localhost:9398/api/tasks/task-1

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

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

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideIntegration with Veeam Backup for AWS User GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.