Farm

PreviousPower Permission NextInvitation Emails

Was this helpful?

Get

get

Retrieve the farm settings

Query parameters

siteIdinteger · int32optional

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/FarmSettings'

200

401

404

{
  "name": "text"
}

Success

Update

put

Modify Farm Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

siteIdinteger · int32optional

Site ID

Body

newNamestring | nullableoptional

The new name of the specified Farm name.

urlBlackListstring[] | nullableoptionalDeprecated

Specifies the URL redirection black list.

sendHDIconsboolean | nullableoptionalDeprecated

Enable or disable Sending HD Icons.

replicateSendHDIconsboolean | nullableoptionalDeprecated

Enable or disable replicate Sending HD Icons.

enableOverlayIconsboolean | nullableoptionalDeprecated

Enable or disable Overlay Icons.

showPasswordExpiryboolean | nullableoptionalDeprecated

Show or hide Password Expiry reminder.

replicateURLRedirectionboolean | nullableoptionalDeprecated

Enable or disable replicate of URL redirection settings.

tokenValidationExpireMininteger · int32 | nullableoptionalDeprecated

Token Validation Time. The time for a validation token to expire in minutes.