REST API - set
  1. Operations
  2. appliance
  3. environment

appliance environment: set

Sets the properties of the appliance environment. This operation was added in vSphere API 6.7.

Request:

HTTP request

PUT https://{server}/rest/appliance/environment

Request Body Structure:

{
    "config" : {
        "managed_by" : "VMWARE",
        "provider" : "AWS",
        "display" : {
            "database_monitoring" : true,
            "sso_status" : true
        },
        "deployed_by" : "VMWARE"
    }
}

Request Body Parameters:

Name Type Description
bold = required
config config Structure containing the values of the Environment.
config.managed_by string Who manages this appliance. This attribute was added in vSphere API 6.7.

Defines the possible entities managing the appliance. This enumeration was added in vSphere API 6.7. Value is one of:
VMWARE: Managed by VMware. This constant was added in vSphere API 6.7.
USER: Managed by the user. This constant was added in vSphere API 6.7.
config.deployed_by string Who have deployed this appliance. This attribute was added in vSphere API 6.7.

Defines the possible entities deploying the appliance. This enumeration was added in vSphere API 6.7. Value is one of:
VMWARE: Deployed by VMware. This constant was added in vSphere API 6.7.
USER: Deployed by the user. This constant was added in vSphere API 6.7.
config.provider string The cloud provider where this appliance is running. This attribute was added in vSphere API 6.7.

Defines the possible providers. Now it has only AWS, in the future we foresee soft-layer, google cloud, azure, etc. This enumeration was added in vSphere API 6.7. Value is one of:
AWS: The appliance is located in AWS-backed VMC. This constant was added in vSphere API 6.7.
UNKNOWN: The appliance location is UNKNOWN. This constant was added in vSphere API 6.7.
config.display display What UI should display. This attribute was added in vSphere API 6.7.
config.display.database_monitoring boolean Display database monitoring. This attribute was added in vSphere API 6.7.
config.display.sso_status boolean Display SSO status. This attribute was added in vSphere API 6.7.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error if any error occurs during the execution of the operation.