Skip to main content
Use these endpoints to read and update MainWP Dashboard settings.
Use the MainWP Postman collection as the source of truth for request and response schemas.

​
Route Matrix

​
General Settings

MethodPathPurposeKey Params
GET/settings/generalGet General Settings-
PUT, PATCH/settings/general/editUpdate General SettingsExamples: timezone_string, time_daily_update, frequency_auto_update, backup_before_upgrade

​
Advanced Settings

MethodPathPurposeKey Params
GET/settings/advancedGet Advanced Settings-
PUT, PATCH/settings/advanced/editUpdate Advanced SettingsExamples: mainwp_maximum_requests, mainwp_minimum_delay, mainwp_ssl_verify_certificate, mainwp_verify_connection_method

​
Monitoring Settings

MethodPathPurposeKey Params
GET/settings/monitoringGet global monitoring settings-
PUT, PATCH/settings/monitoring/editUpdate global monitoring settingsExamples: mainwp_uptime_monitoring_active, mainwp_uptime_monitoring_type, mainwp_uptime_monitoring_interval, mainwp_sitehealth_threshold

​
Email Settings

MethodPathPurposeKey Params
GET/settings/emailsGet email settings-
PUT, PATCH/settings/emails/{mail_type}/editUpdate one email template/settings setmail_type, optional disable, heading, subject, recipients

​
Cost Tracker Settings

MethodPathPurposeKey Params
GET/settings/cost-trackerGet Cost Tracker settings-
PUT, PATCH/settings/cost-tracker/editUpdate Cost Tracker settingscurrency, currency_position, thousand_separator, decimal_separator
POST/settings/cost-tracker/product-types/addAdd product typetitle, optional color, icon
PUT, PATCH/settings/cost-tracker/product-types/{slug}/editEdit product typeslug, title, optional color, icon
DELETE/settings/cost-tracker/product-types/{slug}/deleteDelete product typeslug
POST/settings/cost-tracker/payment-methods/addAdd payment methodtitle
PUT, PATCH/settings/cost-tracker/payment-methods/{slug}/editEdit payment methodslug, title
DELETE/settings/cost-tracker/payment-methods/{slug}/deleteDelete payment methodslug

​
Dashboard Insights

MethodPathPurposeKey Params
GET/settings/dashboard-insightsGet Dashboard Insights settings-
PUT, PATCH/settings/dashboard-insights/editUpdate Dashboard Insights settingsenable_insights_logging

​
API Backups Settings

MethodPathPurposeKey Params
GET/settings/api-backupsGet API Backups provider settings-
PUT, PATCH/settings/api-backups/{api_slug}/editUpdate one API provider configurationapi_slug, provider-specific auth/connection fields (enabled, username, password, url, secrets.api_key)

​
Tools Settings and Tool Actions

MethodPathPurposeKey Params
GET/settings/toolsGet Tools settings-
PUT, PATCH/settings/tools/editUpdate Tools settingsmainwp_theme, guided_tours, chatbase, guided_video
POST/settings/tools/destroy-sessionsStart destroy sessions job-
GET/settings/tools/destroy-sessions-status/{destroy_id}Check destroy sessions job statusdestroy_id
POST/settings/tools/renew-connectionsStart renew connections job-
GET/settings/tools/renew-connections-status/{renew_id}Check renew connections statusrenew_id
POST/settings/tools/disconnect-all-sitesStart disconnect all sites job-
GET/settings/tools/disconnect-all-sites-status/{disconnect_id}Check disconnect-all-sites statusdisconnect_id
POST/settings/tools/clear-activation-dataClear activation data-
POST/settings/tools/restore-info-messagesRestore info messages-

​
Representative Requests

​
Update global monitoring settings

curl -X PUT \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mainwp_uptime_monitoring_active": 1,
    "mainwp_uptime_monitoring_type": "http",
    "mainwp_uptime_monitoring_interval": 5
  }' \
  "https://your-dashboard.com/wp-json/mainwp/v2/settings/monitoring/edit"

{
  "success": 1,
  "message": "Monitoring settings updated successfully."
}

​
Update an API Backups provider

curl -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "username": "api-user",
    "password": "api-secret"
  }' \
  "https://your-dashboard.com/wp-json/mainwp/v2/settings/api-backups/cloudways/edit"

{
  "success": 1,
  "message": "API backup settings updated successfully."
}