Object Cache Pro

Enable or disable Object Cache Pro Redis object caching for a WordPress application from the WordPress Toolkit.

Requires the WordPress Toolkit add-on.

Base path: .../wordpress-toolkit

---

Enable Object Cache Pro

Enable Redis object caching with Object Cache Pro for the target WordPress site.

Provide a valid Object Cache Pro license key from your Object Cache Pro account (opens new window). ServerAvatar does not sell or supply license keys.

Prerequisites: Redis must be installed on the server and the application must be WordPress.

HTTP Request:

POST https://api.serveravatar.com/organizations/{organization}/servers/{server}/applications/{application}/wordpress-toolkit/object-cache-pro/enable

Parameter:

Parameter	Required	Type	Description
license_key	Yes	String	Object Cache Pro license key from your Object Cache Pro account (max 500 characters)

Curl Request Example:

curl --request POST \
  --url "https://api.serveravatar.com/organizations/5/servers/15/applications/93/wordpress-toolkit/object-cache-pro/enable" \
  --header 'content-type: application/json' \
  --header 'Authorization: <YOUR API TOKEN>' \
  --data '{"license_key": "YOUR_OBJECT_CACHE_PRO_LICENSE_KEY"}'

Response:

Successful Response

• 200 (Ok)

{
  "message": "Object Cache Pro enabled successfully.",
  "response": {
    "status": "success",
    "message": "Object Cache Pro enabled successfully"
  }
}

On success, the application record is updated with object_cache_pro_enabled: true and the provided license key.

Validation Error

• 422 (Unprocessable Entity)

{
  "message": "The license key field is required."
}

Server Error

• 500 (Internal Server Error)

{
  "message": "Something went really wrong while enabling Object Cache Pro!"
}

---

Disable Object Cache Pro

Deactivate and remove the Object Cache Pro plugin and clear related Redis configuration from wp-config.php.

HTTP Request:

POST https://api.serveravatar.com/organizations/{organization}/servers/{server}/applications/{application}/wordpress-toolkit/object-cache-pro/disable

No request body required.

Curl Request Example:

curl --request POST \
  --url "https://api.serveravatar.com/organizations/5/servers/15/applications/93/wordpress-toolkit/object-cache-pro/disable" \
  --header 'content-type: application/json' \
  --header 'Authorization: <YOUR API TOKEN>'

Response:

Successful Response

• 200 (Ok)

{
  "message": "Object Cache Pro disabled successfully.",
  "response": {
    "status": "success",
    "message": "Object Cache Pro disabled successfully"
  }
}

On success, the application record is updated with object_cache_pro_enabled: false and the stored license key is cleared.

Server Error

• 500 (Internal Server Error)

{
  "message": "Something went really wrong while disabling Object Cache Pro!"
}