Set Config

Set Config

Sets a configuration property to the provided value.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/site/configurations/{urn}
COPY
Path Parameters
string
urn
Required

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

string
urn
Required

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

Request Body

The configuration with the desired value.

Config of type(s) application/json
Required 
{
    "name": "string",
    "typedValue": {
        "value": {},
        "type": "string"
    },
    "description": "string",
    "defaultValue": {},
    "restartRequired": false,
    "minValue": "number",
    "maxValue": "number",
    "timestamp": "string"
}
string
name
Required

Name of the configuration property.

TypedValue
typedValue
Optional

typedValue

string
description
Optional

A string describing the configuration property.

object
defaultValue
Optional

Default value of the configuration property.

boolean
restartRequired
Optional

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

number As double As double
minValue
Optional

Minimum value for this configuration property.

number As double As double
maxValue
Optional

Maximum value for this configuration property.

string As date-time As date-time
timestamp
Optional

Maximum value for this configuration property.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Name of the configuration property.

TypedValue
typedValue
Optional

typedValue

string
description
Optional

A string describing the configuration property.

object
defaultValue
Optional

Default value of the configuration property.

boolean
restartRequired
Optional

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

number As double As double
minValue
Optional

Minimum value for this configuration property.

number As double As double
maxValue
Optional

Maximum value for this configuration property.

string As date-time As date-time
timestamp
Optional

Maximum value for this configuration property.


Availability
Added in 36.0
On This Page
Configurations Operations
GET
Get Config
GET
Get Configs
PUT
Set Config