ProductsSupportPartnersDocumentation

Farm

Get

get

Retrieve the farm settings

Query parameters
siteIdinteger · int32Optional
Responses
200
Success
application/json; api-version=1.0
get
GET /api/FarmSettings HTTP/1.1
Host: 
Accept: */*

{
  "name": "text"
}

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.

Responses
204
No Content
put
PUT /api/FarmSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 18

{
  "newName": "text"
}
No content
PreviousPower PermissionNextInvitation Emails

Was this helpful?