(PUT) /cloud/tenants/{ID}/subtenants/{ID}

In this article

    Edits settings of a subtenant account with the specified ID.

    Request

    To edit settings of the subtenant account, you need to send the PUT HTTP request to the URL of the /cloud/tenants/{ID}/subtenants/{ID} resource.

    HTTP Request

    PUT https://<Enterprise-Manager>:9398/api/cloud/tenants/{ID}/subtenants/{ID}

    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.

    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 for the subtenant account whose settings must be updated. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager REST API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    Description

    String

    Description for the subtenant account.

    Yes

    0/1

    Password

    String

    Password for the subtenant account.

    Yes

    0/1

    Enabled

    Boolean

    Defines if the subtenant account must be in the enabled or disabled state.

    Yes

    0/1

    RepositoryQuota

    CloudSubtenantRepositoryQuotaInfoType

    Parameters for the storage quota assigned to the subtenant account. For details, see Subtenant Quota Settings.

    Yes

    0/1

     

    Note

    You cannot change a user name for a subtenant account.

    For example:

    XML Representation

    <?xml version="1.0" encoding="utf-8"?>
    <CloudSubtenant Href="https://localhost:9398/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" Type="CloudSubtenant" Id="0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" 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">
     <Name>ABC Company User 01</Name>
     <Description>ABC Company PC User</Description>
     <Password/>
     <Enabled>true</Enabled>
     <RepositoryQuota Unlimited="true">
       <DisplayName>Cloud Vol User 01</DisplayName>
       <TenantResourceId>11c59670-23df-448c-a4b3-74c42669633e</TenantResourceId>
       <QuotaMb>10240</QuotaMb>
       <UsedQuotaMb>0</UsedQuotaMb>
     </RepositoryQuota>
    </CloudSubtenant>

    JSON Representation

    {

     "Name": "ABC Company User 01",

     "Description": "ABC Company PC User",

     "Password": "",

     "Enabled": true,

     "RepositoryQuota": {

       "DisplayName": "Cloud Vol User 01",

       "TenantResourceId": "11c59670-23df-448c-a4b3-74c42669633e",

       "QuotaMb": 10240,

       "UsedQuotaMb": 0,

       "Unlimited": true

     },

     "Id": "0eb0c130-d91a-4e05-9403-ac2ded0fc1ea",

     "Href": "https://localhost:9398/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea",

     "Type": "CloudSubtenant"

    }

    Subtenant Quota Settings

    You can define the following parameters for the storage quota assigned to the subtenant account:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    DisplayName

    String

    Friendly name of the storage quota assigned to the subtenant.

    Yes

    0/1

    TenantResourceId

    String

    ID of the tenant storage quota on which the storage quota for the subtenant account must be created, for example: 11c59670-23df-448c-a4b3-74c42669633e.

    Yes

    0/1

    QuotaMb

    Int

    Size of the storage quota assigned to the subtenant (in MB). Subtenant quota cannot be less than 1GB. Size of the subtenant quota must be defined if the False value is specified for the Unlimited attribute of the RepositoryQuota element.

    Yes

    1/1

     

    Note

    To define whether the storage quota assigned to the subtenant must be unlimited or not, specify the necessary value for the Unlimited attribute of the RepositoryQuota element. Possible values:

    • True — the subtenant quota is not limited. The subtenant can use all storage space available within the tenant quota. The subtenant quota limit specified in the QuotaMb element is ignored.
    • False — the subtenant quota is limited. Size of the subtenant quota must be defined in the QuotaMb element.

    For example:

    XML Representation

    <RepositoryQuota Unlimited="false">
     <DisplayName>Cloud Vol User 01</DisplayName>
     <TenantResourceId>11c59670-23df-448c-a4b3-74c42669633e</TenantResourceId>
     <QuotaMb>20480</QuotaMb>
     <UsedQuotaMb>0</UsedQuotaMb>
    </RepositoryQuota>

    JSON Representation

    "RepositoryQuota": {

     "DisplayName": "Cloud Vol User 01",

     "TenantResourceId": "11c59670-23df-448c-a4b3-74c42669633e",

     "QuotaMb": 10240,

     "UsedQuotaMb": 0,

     "Unlimited": true

    }

    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 updates the storage quota settings for the subtenant account with ID 0eb0c130-d91a-4e05-9403-ac2ded0fc1ea.

    Request:

    PUT https://localhost:9398/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea

     

    Request Headers:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
    Content-Type         application/xml

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <CloudSubtenant Href="https://localhost:9398/api/cloud/tenants/28ddf9b9-12fa-431a-a34c-a327f05c3920/subtenants/0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" Type="CloudSubtenant" Id="0eb0c130-d91a-4e05-9403-ac2ded0fc1ea" 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">
     <Name>ABC Company User 01</Name>
     <Description>ABC Company PC User</Description>
     <Password/>
     <Enabled>true</Enabled>
     <RepositoryQuota Unlimited="false">
       <DisplayName>Cloud Vol User 01</DisplayName>
       <TenantResourceId>11c59670-23df-448c-a4b3-74c42669633e</TenantResourceId>
       <QuotaMb>20480</QuotaMb>
       <UsedQuotaMb>0</UsedQuotaMb>
     </RepositoryQuota>
    </CloudSubtenant>

     

    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>EditCloudSubtenant</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" 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>Finished</State>
     <Operation>EditCloudSubtenant</Operation>
     <Result Success="true">
       <Message>Ok</Message>
     </Result>
    </Task>

     

    I want to report a typo

    There is a misspelling right here:

     

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