GET /vCloud/orgConfigs/{ID}

In this article

    Returns a resource representation of a vCloud Director organization configuration with the specified ID.

    Request

    To get a resource representation of the vCloud Director organization configuration, send the GET HTTP request to the URL of the /vCloud/orgConfigs/{ID} resource:

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/vCloud/orgConfigs/{ID}

    or

    GET https://<Enterprise-Manager>:9398/api/vCloud/orgConfigs/{ID}?format=Entity

    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.

    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, Veeam Backup Enterprise Manager returns an entity or an entity reference of the /vCloud/orgConfigs/{ID} resource. The resource entity contains the following parameters and links.

    Parameters

    Element

    Type

    Description

    UID

    UidType

    UID of the vCloud Director organization configuration resource, for example: urn:veeam:BackupFile:0874ab95-10e5-4f25-84df-2782ad81f3e5.

    Name

    String

    Name of the vCloud Director organization configuration resource, for example: org1.

    BackupServerUid

    UidType

    UID of the backup server parent to the vCloud Director organization configuration resource.

    RepositoryUid

    UidType

    UID of the backup repository on which the storage quota for the vCloud Director organization is created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4.

    QuotaGb

    Long

    Size of the storage quota assigned to the vCloud Director organization (in GB).

    IsDisabled

    Boolean

    Defines if the default vCloud Director organization configuration is in the disabled or enabled state. Possible values:

    • True — the default configuration is disabled. Self-service backup is unavailable for vCloud Director organizations that do not have individual configurations.
    • False — the default configuration is enabled. vCloud Director organizations for which individual configurations were not created can perform self-service backup.

    JobSettings

    Job settings used for the organization configuration. For details, see Job Settings.

    UsedQuotaMb

    Long

    Amount of space on the storage quota consumed by the vCloud Director organization (in MB).

    HostUid

    UidType

    UID of the vCloud Director host where the vCloud Director organization has been created.

    The parameter is available starting from Veeam Backup Enterprise Manager 11a (build 11.0.1.1261).

    RepositoryFriendlyName

    String

    Backup repository name displayed to vCloud Director organization members, for example: Backup Repository 1.

    The parameter is available starting from Veeam Backup Enterprise Manager 11a (build 11.0.1.1261).

    To view query parameters that you can use for filtering or sorting, see GET /query?type=VCloudOrganizationConfig.

    Job Settings

    The JobSettings element contains the following job settings.

    Element

    Type

    Description

    DefaultSettings

    Boolean

    Defines if the default vCloud Director organization configuration is in the disabled or enabled state. Possible values:

    • True — the default configuration is disabled. Self-service backup is unavailable for vCloud Director organizations that do not have individual configurations.
    • False — the default configuration is enabled. vCloud Director organizations for which individual configurations were not created can perform self-service backup.

    JobSchedulerType

    String

    Job scheduling options. Possible values:

    • Full — vCloud Director organization members have full access to all job scheduling options.
    • Partial — vCloud Director organization members can create daily and monthly jobs only.
    • Random — vCloud Director organization members can create daily jobs with randomized start time within the backup window.
    • Disabled — vCloud Director organization members can create only jobs with no schedule assigned.

    HighPriorityJob

    Boolean

    Defines whether the backup job has a high priority. Possible values:

    • True
    • False

    TemplateJobUid

    UidType

    UID of the vCloud Director backup job that will be used as a template for vCloud Director organization VMs processing. The backup job must be created in advance on the 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 UID is not specified, tenant-side jobs will be configured with the default vCloud Director backup job settings.

    Job settings applied to backup jobs for the vCloud Director organization will be listed in the representation of the /vCloud/orgConfigs/{ID}/backupJobSettings resource.

    Links

    Reference

    Relationship

    Description

    /backupServers/{ID}

    Up

    URL of the /backupServers/{ID} resource — a backup server that contains the vCloud Director server in its infrastructure.

    /vCloud/orgConfigs/{ID}

    Alternate

    Alternate URL of the /vCloud/orgConfigs/{ID} resource.

    /vCloud/orgConfigs/{ID}

    Edit

    URL for the PUT /vCloud/orgConfigs/{ID} request.

    /vCloud/orgConfigs/{ID}

    Delete

    URL for the DELETE /vCloud/orgConfigs/{ID} request.

    /vCloud/orgConfigs/{ID}/backupJobSettings

    Down

    URL of the /vCloud/orgConfigs/{ID}/backupJobSettings resource — job settings applied to backup jobs for the vCloud Director organization.

    Example

    The example below returns an entity representation of the configuration with ID ee1018b4-6f52-489e-80b7-8005e0b2d640.

    Request:

    GET https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <VCloudOrganizationConfig xmlns="http://www.veeam.com/ent/v1.0" Type="VCloudOrganizationConfig" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity" Name="org1" UID="urn:veeam:VCloudOrganizationConfig:ee1018b4-6f52-489e-80b7-8005e0b2d640">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/1cf4ea89-89d9-4b4e-a285-71bd8c705222" Name="172.17.53.2" />
       <Link Rel="Alternate" Type="VCloudOrganizationConfigReference" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" Name="org1" />
       <Link Rel="Edit" Type="VCloudOrganizationConfigReference" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" Name="org1" />
       <Link Rel="Disable" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?action=disable" />
       <Link Rel="Delete" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" />
       <Link Rel="Down" Type="VCloudOrganizationConfigBackupJobSettings" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640/backupJobSettings" Name="org1" />
     </Links>
     <BackupServerUid>urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222</BackupServerUid>
     <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
     <QuotaGb>100</QuotaGb>
     <IsDisabled>false</IsDisabled>
     <JobSettings>
       <CustomSettings>true</CustomSettings>
       <JobSchedulerType>Full</JobSchedulerType>
       <HighPriorityJob>false</HighPriorityJob>
     </JobSettings>
     <UsedQuotaMb>120</UsedQuotaMb>
     <HostUid>urn:veeam:ManagedServer:24a14898-77d0-4881-bbf8-c8ba71ce4d55</HostUid>
     <RepositoryFriendlyName>Repository 1</RepositoryFriendlyName>
    </VCloudOrganizationConfig>