Site Settings

Read and update WordPress general settings: language, timezone, date/time formats, permalinks, search engine visibility, and WordPress memory limits.

Requires the WordPress Toolkit add-on.

---

Get Site Settings

HTTP Request:

GET https://api.serveravatar.com/organizations/{organization}/servers/{server}/applications/{application}/wordpress-toolkit/site-settings

Curl Request Example:

curl --request GET \
  --url "https://api.serveravatar.com/organizations/5/servers/15/applications/93/wordpress-toolkit/site-settings" \
  --header 'Authorization: <YOUR API TOKEN>'

Response:

Successful Response

• 200 (Ok)

{
  "response": {
    "site_language": "en_US",
    "timezone": "Etc/UTC",
    "date_format": "F j, Y",
    "time_format": "g:i a",
    "permalink_structure": "/%year%/%monthnum%/%day%/%postname%/",
    "search_engine_visibility": false,
    "wp_memory_limit": "256M",
    "wp_max_memory_limit": "512M"
  }
}

---

Update Site Settings

HTTP Request:

PATCH https://api.serveravatar.com/organizations/{organization}/servers/{server}/applications/{application}/wordpress-toolkit/site-settings

Parameter:

Parameter	Required	Type	Description
site_language	Yes	String	WordPress locale (e.g. en_US). You can get available languages from the Language API.
timezone	Yes	String	PHP timezone string. You can get a list of timezones from the Timezone API.
date_format	Yes	String	WordPress date format
time_format	Yes	String	WordPress time format
permalink_structure	No	String	Permalink structure (e.g. /%postname%/)
search_engine_visibility	No	String	"true" to discourage search engines; "false" to allow indexing
wp_memory_limit	No	String	WordPress memory limit. Must end with M or G (e.g. 256M, 1G)
wp_max_memory_limit	No	String	WordPress max memory limit. Must end with M or G (e.g. 512M, 1G)

Curl Request Example:

curl --request PATCH \
  --url "https://api.serveravatar.com/organizations/5/servers/15/applications/93/wordpress-toolkit/site-settings" \
  --header 'content-type: application/json' \
  --header 'Authorization: <YOUR API TOKEN>' \
  --data '{
    "site_language": "en_US",
    "timezone": "America/New_York",
    "date_format": "F j, Y",
    "time_format": "g:i a",
    "permalink_structure": "/%postname%/",
    "search_engine_visibility": "false",
    "wp_memory_limit": "256M",
    "wp_max_memory_limit": "512M"
  }'

Response:

Successful Response

• 200 (Ok)

{
  "response": {
    "message": "Settings updated successfully",
    "status": "success"
  }
}

Validation Error

• 422 (Unprocessable Entity)

{
  "message": "At least one setting is required."
}