Changed2
[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Set Config

Description

Sets a configuration property to the provided value.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/site/configurations/{urn}
Copy

Path Parameters

Path Parameters

string
urn Required

URN containing the name of the configuration property such as (urn:vcloud:configuration:)


Request Body

Request Body

Config of type(s) application/json Required

The configuration with the desired value.

{
	"name": "string"
}
string
name Required

Name of the configuration property.


defaultValue Introduced Changed Optional

Default value of the configuration property.


string
description Introduced Changed Optional

A string describing the configuration property.


number as double
maxValue Introduced Changed Optional

Maximum value for this configuration property.


number as double
minValue Introduced Changed Optional

Minimum value for this configuration property.


boolean
restartRequired Introduced Changed Optional

Represents if the cell needs to be rebooted for a change to this property to take effect.


string as date-time
timestamp Introduced Changed Optional

Maximum value for this configuration property.


typedValue Optional

The value of the configuration property.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Config of type(s) application/json;version=37.0
{
	"defaultValue": {},
	"description": "string",
	"maxValue": 0,
	"minValue": 0,
	"name": "string",
	"restartRequired": false,
	"timestamp": "string",
	"typedValue": {
		"type": "string",
		"value": {}
	}
}
string
name Required

Name of the configuration property.


defaultValue Introduced Changed Optional

Default value of the configuration property.


string
description Introduced Changed Optional

A string describing the configuration property.


number as double
maxValue Introduced Changed Optional

Maximum value for this configuration property.


number as double
minValue Introduced Changed Optional

Minimum value for this configuration property.


boolean
restartRequired Introduced Changed Optional

Represents if the cell needs to be rebooted for a change to this property to take effect.


string as date-time
timestamp Introduced Changed Optional

Maximum value for this configuration property.


typedValue Optional

The value of the configuration property.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"defaultValue":{},"description":"string","maxValue":0,"minValue":0,"name":"string","restartRequired":false,"timestamp":"string","typedValue":{"type":"string","value":{}}}' https://{api_host}/cloudapi/1.0.0/site/configurations/{urn}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcloud-event: com/vmware/vcloud/event/configuration/property/modify


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
What's changed in v37.0?
INTRODUCED
New in this version
Availability
Added in 36.0
Configurations Operations
Feedback

Was this page helpful?