A system administrator can retrieve or update a cloud-wide set of system properties. These properties specify default values and behaviors for the cloud and all of the organizations in it.

The SystemSettings element includes all system settings for this cloud. The element also includes links that allow you to retrieve these subsidiary elements, which define specific categories of settings.


Control the configuration and behavior of the entire cloud.


Control the vCloud Director AMQP notifications service.


Specify details of the system LDAP directory service.


Specify credentials and connection information for the AMQP broker that handles notifications and blocking task messages.


Define configuration and connection parameters for the system default email service, and specifies properties of email alerts that the system sends.


System license serial number and related settings.


Customize the branding of the vCloud Director Web Console and some of the links that appear on the vCloud Director Home login screen.


Control the behavior of blocking tasks and enable blocking for specific operations.


Specify default policies to be followed when a user in any organization enters an incorrect password. Organization administrators can override this default for their organizations.


Specify the vSphere Lookup Service URL so system administrators can authenticate using vSphere Single Sign-On (SSO).


Specify the schedule for background synchronization of catalogs that have an external subscription. These settings apply to all organizations in the system.

You can retrieve the entire SystemSettings element to view all of these settings. To update an individual subsection, retrieve it with a GET request, modify it, and update it with a PUT request.

Verify that you are logged in to the vCloud API as a system administrator.


Retrieve the SystemSettings element.

Use a request like this one.

GET https://vcloud.example.com/api/admin/extension/settings

Examine the response to locate the Link elements that you can use to retrieve an individual subsection.

These links have a rel attribute value of down.


Use the link to retrieve the subsection.

Make a GET request to the href value of the link.


(Optional) Modify the retrieved subsection.

Subsections that you can modify include a link where rel="edit".


(Optional) To update the subsection, PUT the modified subsection to the href of the link described in Step 4.