# > Documentation for WebPros Dashboard Base URL: https://docs.dashboard.webpros.com/ Generated: 2026-10-09 --- ## [Get started with WebPros Dashboard](https://docs.dashboard.webpros.com/docs/get-started/getting-started-with-webpros-dashboard/)

Overview

The WebPros Dashboard interface contains several menus and options that allow you to configure and monitor your servers and domains.

Note:

If you do not already have a WebPros Dashboard account, you can create one at: dashboard.webpros.com.

the webpros dashboard interface

WebPros Dashboard consists of the following sections:

Dashboards

The Dashboards menu displays your servers, domains, and recent alerts. This is the default menu when you log in.

If you want to create a custom dashboard, read our Add Dashboard documentation.

Servers

The Servers menu displays a list of all your servers and their current status.

You can use the Filters menu to customize the view:

Filter Description
Offline Servers whose agents have not responded.
Issues Servers whose agents have recently reported a problem.
cPanel Your cPanel & WHM servers.
Plesk Your Plesk servers.
Muted Servers that you have disabled alerting.

You can also sort your servers via the Order by menu. You can order your servers by Issues, Name, or Date added.

You can add your servers to WebPros Dashboard to monitor their online status and get alerts when they are offline. For more information, read our Add or remove a server documentation.

Domains

The Domains menu displays a list of all your domains. Select a domain to manage monitoring, maintenance, alerts, and mail. You can use the Filters menu to customize the view:

Filter Description
Server Display domains that are tagged as part of a server in Dashboard.
Issues Display domains where the Dashboard has recently detected a problem.
Muted Display domains for which you have paused alerts.

You can also sort your domains via the Order by menu. You can order your domains by Issues, Name, Date added, or Load time.

You can add your domains to WebPros Dashboard to monitor their online status and get alerts when they are offline. For more information, read our Manage domains documentation.

Alerts

The Alerts menu displays the alerts for your servers and domains. You can configure when to receive alerts and who should receive them. This menu contains three tabs:

Tab Description
History View a list of alerts from your servers and domains.
Alerts Configure when your WebPros Dashboard should send alerts.
Contacts Manage contact details and configure how your WebPros Dashboard should notify them.

Tools

The Tools menu contains additional features to manage your servers and domains.

Feature Description
Blocklist Monitor whether any of your IP addresses appear on a spam list. You can also review and search the spam list providers that WebPros Dashboard queries.
Status Pages Create a publicly accessible dashboard website and server status pages. For more information, read our Pages documentation.
Full Site Check Crawl your entire website and generate a comprehensive report on errors and anomalies. The report may include dead links, broken images, JavaScript errors, and other issues.
--- ## [Use the WebPros Dashboard API](https://docs.dashboard.webpros.com/docs/api/use-the-webpros-dashboard-api/)

Overview

The WebPros Dashboard API lets you manage servers, API tokens, and team invitations with HTTP requests. Use it to automate the tasks you would otherwise perform in the WebPros Dashboard interface, or to connect WebPros Dashboard to your own integration.

The API accepts and returns JSON, and every request needs an API token. For the full list of endpoints, request bodies, and response schemas, read the WebPros Public API specification.

Prerequisites

You must create an API token before you can call the API. WebPros Dashboard shows the token value only once, so copy it and store it in a secure location. For more information, read our Create and manage API tokens documentation.

Authenticate a request

The base URL includes the API version:

1https://dashboard.webpros.com/api/v1

Send your API token as a bearer token in the Authorization header of every request:

1Authorization: Bearer YOUR_API_TOKEN

A request that carries no valid token returns a 401 response.

Endpoint groups

The API organizes its endpoints into the following groups:

Group Description
Accounts Sends team invitation emails and returns the team GUID for an email address.
API tokens Lists, creates, reads, and deletes the API tokens of the calling user. Requires a token that carries the manage-api-tokens claim.
Server Inventory Connects servers to Server Inventory, lists the connected servers, and deletes a server by its GUID.

Scope a token with claims

A claim is a permission that a token carries. A token that carries no claims is unrestricted and can call any operation. A token that carries claims can only call the operations that require exactly those claims.

The API defines the following claims:

The mcp claim takes an attributes object. Set serverGuid to scope the token to a single server, and add the optional panelUser to scope it to a single panel user on that server. Set readonly to true to restrict the token to read tools and methods.

Important:

The API returns a 403 response in both of the following cases:

Paginate results

The endpoints that return a paginated list accept the following query parameters:

The GET /dashboard/api-tokens endpoint also accepts a filter parameter. The API matches its value as a case-insensitive substring against the token name.

Examples

List your connected servers

Run the following command to list the servers in your Server Inventory, replacing YOUR_API_TOKEN with your API token:

1curl -X GET "https://dashboard.webpros.com/api/v1/si/servers?page=1&pageSize=10" \
2  -H "Authorization: Bearer YOUR_API_TOKEN"

The API returns the total number of connected servers and an array of server objects:

 1{
 2  "totalCount": 1,
 3  "data": [
 4    {
 5      "guid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
 6      "product": "plesk",
 7      "address": "https://example.com",
 8      "active": true
 9    }
10  ]
11}

Create a scoped API token

Run the following command to create a read-only token for a single server. Replace YOUR_API_TOKEN with a token that carries the manage-api-tokens claim, and serverGuid with the GUID of your server:

 1curl -X POST "https://dashboard.webpros.com/api/v1/dashboard/api-tokens" \
 2  -H "Authorization: Bearer YOUR_API_TOKEN" \
 3  -H "Content-Type: application/json" \
 4  -d '{
 5    "name": "Read-only MCP token",
 6    "claims": [
 7      {
 8        "name": "mcp",
 9        "readonly": true,
10        "attributes": {
11          "serverGuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
12        }
13      }
14    ]
15  }'

The API returns the new token and its secret in the token property:

 1{
 2  "data": {
 3    "id": 42,
 4    "name": "Read-only MCP token",
 5    "type": "user",
 6    "claims": [
 7      {
 8        "name": "mcp",
 9        "readonly": true,
10        "attributes": {
11          "serverGuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
12        }
13      }
14    ],
15    "createdAt": "2024-01-15T09:00:00-05:00",
16    "lastUsedAt": null,
17    "expireAt": null,
18    "token": "<the raw token value>"
19  }
20}
Remember:

The API returns the token value only when you create the token. Copy it and store it in a secure location. If you lose it, delete the token and create a new one.

Error responses

The API returns the following errors:

Status Meaning
400 The request contains invalid input. The response body lists the type, path, and message for each invalid field.
401 The request carries no valid API token.
403 The token does not carry the required claim, is read-only, or requests claims broader than its own.

Read the API specification

The WebPros Public API specification is the authoritative reference for the API. Open it when you build an integration or need the exact details of a specific call.

--- ## [Add or remove a server with WebPros Dashboard](https://docs.dashboard.webpros.com/docs/get-started/add-or-remove-a-server-with-dashboard/)

Overview

This document explains how to add or remove a server with WebPros Dashboard. You can add servers that use Plesk, cPanel & WHM, or servers without a control panel.

Note:

WebPros Dashboard can take up to one minute to show new servers.

How to add a Plesk server

To add a Plesk server, perform the following steps:

  1. Click + Add and then Server.
  2. Click Plesk server.
  3. In the Server hostname text box, enter your server’s hostname.
  4. Enter a search tag in the Tags text box, if needed.
  5. Click Proceed in Plesk. A new browser tab will open to your Plesk server.
  6. Log in to your Plesk server.
  7. In the Confirm connecting your server to “WebPros Dashboard” popup, click Confirm.

How to add a cPanel & WHM server

To add a cPanel & WHM server, perform the following steps:

  1. Click + Add and then Server.
  2. Click cPanel server. The Add cPanel Server window will appear.
  3. Copy the provided code and run it on your cPanel & WHM server as the root user.
  4. Click Go to servers.

How to add a server without a control panel

To add a server without a control panel, perform the following steps:

  1. Click + Add and then Server.
  2. Click Server with no hosting control panel.
  3. Click Install monitoring agent only.
  4. Select the operating system tab for your server and perform the following steps:
  5. Click Go to servers.

How to remove a server

To remove a server, perform the following steps:

  1. Click the vertical ellipsis (⋮) next to the server you wish to remove.
  2. Click Disconnect server.
  3. In the confirmation window, click Disconnect.
--- ## [Manage domains](https://docs.dashboard.webpros.com/docs/get-started/manage-domains/)

Overview

The Domains menu in WebPros Dashboard displays a list of all your domains. Select a domain to manage monitoring, maintenance, alerts, and mail.

Note:

To manage mail for your domain from WebPros Dashboard, you must provision a Business Email domain from WebPros.

Add a domain

To add a domain to WebPros Dashboard, perform the following steps:

  1. Click + Add and then click Create Website. The Website monitoring interface appears.
  2. Select one of the following monitoring protocols:
  3. Enter your domain’s URL or an IP address.
  4. Click Advanced to select your alert preferences for this domain.
  5. Click Save.

Manage a domain

You can select a domain to manage monitoring, maintenance, alerts, and mail in WebPros Dashboard.

Monitoring

WebPros Dashboard displays a section for each monitoring protocol that the domain uses. For example, HTTP and HTTPS. Click one of these sections to open the Monitoring interface for that protocol. The Monitoring interface contains the following sections:

Section Description
Date The date range to analyze performance data. Use the update interval toggle to set how often the graph refreshes automatically.
Performance A response time graph for a probe location. Use the location dropdown to switch between locations.
Location A list of active probe locations, server response codes, and average performance. Click Add to monitor additional locations.
Alerts A list of recent alerts for the domain.
Info General monitoring information for the domain. Review the monitoring start date, last outage, SSL certificate status, and monitoring protocol.

To export a monitoring report, perform the following steps:

  1. Click the vertical ellipsis (ellipsis icon) icon and select Save Report.
  2. Select a monitoring protocol and a date range.
  3. Click Export.

To manage your alert settings for this domain, click the vertical ellipsis (ellipsis icon) icon and select Settings.

Maintenance

The Maintenance section shows your scheduled maintenance windows for a domain. WebPros Dashboard mutes alerts for the domain during this period.

To create a new maintenance window, perform the following steps:

  1. Click Add Window and select a monitoring protocol.
  2. Enter the window’s details. You must add a title, severity, frequency, start date, and end date.
  3. Click Save.

You can pause, edit, and remove your maintenance windows from the Maintenance section.

Alerts

The Alerts section displays recent alerts for the domain. It contains the following tabs:

Tab Description
History View a list of alerts that the domain triggered. Use the Filters menu to filter by severity, metric, or period.
Triggers Enable, disable, or edit alerts for a monitoring protocol.

Mail

The Mail section organizes your business email management tools across the following sections:

Section Description
DNS View and configure DNS mail records (DKIM, SPF, MX, DMARC) or copy autodiscovery records. Click Check status to verify whether your DNS records have propagated.
Mailboxes Create and manage individual email accounts for your domain. Each mailbox has its own storage, credentials, and settings for sending and receiving emails.
Delivery log Track email delivery history and status for all mailboxes in your domain.
Forwarders Set up forwarding rules to redirect incoming email from one address to another.
Aliases Create secondary email addresses that automatically deliver messages to a primary mailbox.
Auto-responders Configure automatic replies for incoming emails. Use auto-responders for out-of-office notices or customer confirmation messages.
Catch-all policy Define how your domain handles emails for non-existent addresses. You can reject them or forward them to another mailbox.
Connection guides Access step-by-step setup instructions for Android™, iPhone®, Microsoft Outlook®, and Apple® Mail. Review IMAP and SMTP server settings.
Subscription View the status of your current plan and increase your plan limits.

Remove a domain

To remove a domain from WebPros Dashboard, perform the following steps:

  1. Click the vertical ellipsis (ellipsis icon) icon next to the domain you want to remove.
  2. Click Monitoring (monitoring icon).
  3. Click Stop monitoring (trashcan icon) twice to confirm your decision.
--- ## [Connect to the MCP server](https://docs.dashboard.webpros.com/docs/mcp/connect-to-the-mcp-server/)

Overview

This document explains how to connect Claude Code, GitHub® Copilot, or Visual Studio Code to WebPros Dashboard’s Model Context Protocol (MCP) server. When you set up the connection, your AI agent can interact with the servers, domains, and resources in your account using an MCP key.

About the MCP interface

The MCP interface (Account Menu » MCP) allows you to manage your MCP settings. You decide which resources an agent can reach, whether it can change them or only read them, and which MCP tools are available.

An MCP tool is a specific function that your agents call to interact with your WebPros Dashboard account. For example, you can ask your AI agent to list your WebPros Dashboard servers or run a Plesk API method. For the complete list of available tools, read our MCP tools documentation.

This feature is useful when you want to:

Prerequisites

Before you connect to the MCP server, you need to set up the following:

  1. You must create an MCP key before you can connect to your account’s MCP server. For more information, read our Create and manage MCP keys documentation.
  2. Optionally, you can also create an API token to connect to the WebPros Dashboard API. For more information, read our Create and manage API tokens documentation.

Connect an AI agent

An agent is an AI-powered client that connects to the WebPros Dashboard MCP server and calls its tools on your behalf. When you give an agent a task, it calls the relevant MCP tool to complete it. Popular agentic platforms to manage WebPros Dashboard include Claude Code, GitHub Copilot, and VS Code.

Note:

We strongly recommend you monitor the actions your agents take through the MCP server. For more information, read our Manage MCP keys and agent activity documentation.

Claude Code

Run the following command to connect Claude Code to the WebPros Dashboard MCP, replacing YOUR_WEBPROS_MCP_KEY with your MCP key:

1claude mcp add --transport http webpros-dashboard https://mcp.webpros.com/api/mcp --header "Authorization: Bearer YOUR_WEBPROS_MCP_KEY"

For more information, read Claude Code’s Connect MCP servers to Claude Code documentation.

GitHub Copilot

Run the following command to connect GitHub Copilot to the WebPros Dashboard MCP, replacing YOUR_WEBPROS_MCP_KEY with your MCP key:

1copilot mcp add --transport http webpros-dashboard https://mcp.webpros.com/api/mcp --header "Authorization: Bearer YOUR_WEBPROS_MCP_KEY"

For more information, read GitHub’s Adding MCP servers for GitHub Copilot CLI documentation.

Visual Studio Code

To connect VS Code to the WebPros Dashboard MCP, perform the following steps:

  1. Open the Command Palette (Ctrl+Shift+P on Windows®/Linux® or Cmd+Shift+P on macOS®) and run MCP: Open User Configuration. VS Code opens the mcp.json file or creates it if it doesn’t exist yet.

  2. Replace YOUR_WEBPROS_MCP_KEY with your MCP key in the following snippet. Then, paste it into the file and save it.

     1{
     2	"servers": {
     3		"webpros-dashboard": {
     4			"url": "https://mcp.webpros.com/api/mcp",
     5			"type": "http",
     6			"headers": {
     7				"Authorization": "Bearer YOUR_WEBPROS_MCP_KEY"
     8			}
     9		}
    10	}
    11}
    
  3. Open the Command Palette and run MCP: List Servers.

  4. Select the WebPros Dashboard MCP server, and then select one of the following options:

  5. Open the Chat view (Ctrl+Alt+I on Windows/Linux or Cmd+Shift+I on macOS) and set the chat mode to Agent.

  6. Select Configure Tools in the chat input to manage the available WebPros Dashboard MCP tools.

  7. Enter a prompt describing the action you want the agent to perform.

For example, you could use the following prompt to call the si_cpanel_user_api_method_execute tool and list the email accounts for the username cPanel user on example.com:

1List all email accounts for the cPanel user username on example.com.

For more information, read VS Code’s Add and manage MCP servers in VS Code documentation.

--- ## [WebPros Cloud Changelog](https://docs.dashboard.webpros.com/changelogs/versions/changelog/)

2025-0

0.1.1


released on 2025-00-01

--- ## [Create and manage MCP keys](https://docs.dashboard.webpros.com/docs/mcp/create-and-manage-mcp-keys/)

Overview

An MCP key is the credential an AI agent uses to connect to an MCP server. You can create multiple MCP keys in WebPros Dashboard to scope an agent’s access to all servers, one server, or one account, and to control whether it has read-only or read/write access.

For instructions to connect your AI agent to the MCP server after you create a key, read our Connect to the MCP server documentation.

Create an MCP key

To create an MCP key, navigate to the MCP interface (Account Menu » MCP) and perform the following steps:

  1. Click + Add, then click Create MCP Key.
  2. Enter a name for the key in the Enter a key name text box.
  3. Select an access level for your key. You can select Server Access or Key Management.
  4. Click Create.
Note:

WebPros Dashboard shows the MCP key value only once after you create it. Copy the key and store it in a secure location. If you lose it, delete the key and create a new one.

Manage MCP keys and agent activity

Warning:

Agents can only act within the access scope you set when you create the MCP key. However, we strongly recommend you monitor the actions your agents take and ensure they are behaving as you expect.

To monitor and configure how agents use your MCP keys, navigate to the MCP interface (Account Menu » MCP).

Manage your MCP keys

Select the Keys tab to manage your existing keys.

Find a key

To find a specific key, enter its name in the Filter search box.

Rename a key

To rename a key, click the vertical ellipsis (ellipsis icon) next to it and select Rename.

Delete a key

To delete a key, click the vertical ellipsis (ellipsis icon) next to it and select Delete Key.

View MCP tool call logs

The Logs tab shows your MCP tool calls and groups them by date. Use it to audit agent activity and to debug unexpected results.

You can narrow the list using the following controls:

To see the details for a single call, click its row. The details page includes additional information like latency, JSON input, and JSON output.

Manage MCP tools

The Global Tool Availability tab lists every MCP tool available for your account.

To see the complete list of tools that the WebPros Dashboard MCP server can expose, read our MCP tools documentation.

Enable or disable a tool

To enable or disable a tool, click the Enabled or Disabled control next to it. This setting defines whether the tool can run for any key, regardless of that key’s scope.

Change a tool’s access mode

To change the access mode of a tool, click the Read Only or Read / Write control next to it. This setting defines whether agents can only read data or also write it. You cannot change the access mode of Read Only tools.

--- ## [Create and manage API tokens](https://docs.dashboard.webpros.com/docs/mcp/create-and-manage-api-tokens/)

Overview

An API token is a credential you generate to authenticate requests to a specific web service or server. You can use API tokens in WebPros Dashboard to automate tasks and to create new API tokens and MCP keys.

Create an API token

To create an API token, navigate to the API tokens interface (Account Menu » API Tokens) and perform the following steps:

  1. Click + Add, then click Create API Token.
  2. Enter a name for the token in the Enter a token name text box.
  3. Click Create. WebPros Dashboard displays the new API token.
Note:

WebPros Dashboard shows the API token value only once after you create it. Copy the token and store it in a secure location. If you lose it, delete the token and create a new one.

Manage your API tokens

The API Tokens interface (Account Menu » API Tokens) lists your existing tokens.

Find a token

To find a specific token, enter its name in the Filter search box.

Rename a token

To rename a token, click the vertical ellipsis (ellipsis icon) next to it and select Rename.

Delete a token

To delete a token, click the vertical ellipsis (ellipsis icon) next to it and select Delete Token.

--- ## [MCP tools](https://docs.dashboard.webpros.com/docs/mcp/mcp-tools/)

Overview

The MCP tools in WebPros Dashboard allow your AI agents to interact with the servers, domains, and resources in your account. This page lists every available tool by product. For instructions on creating MCP keys and enabling or disabling these tools, read our Create and manage MCP keys documentation.

There are three core types of MCP tools for each product:

Plesk API

These tools discover and run Plesk API methods on your Plesk servers:

Tool Access Description
si_plesk_api_method_list Read Only Reads which Plesk API methods are available, with a short summary of each.
si_plesk_api_method_usage Read Only Describes what a specific Plesk API method does and which parameters it expects.
si_plesk_api_method_execute Read / Write Runs a Plesk API method on a Plesk server you connect to WebPros Dashboard.

WHM API

These tools discover and run WHM API methods on your cPanel & WHM servers:

Tool Access Description
si_cpanel_whm_api_method_list Read Only Reads which WHM API methods are available, with a short summary of each.
si_cpanel_whm_api_method_usage Read Only Describes what a specific WHM API method does and which parameters it expects.
si_cpanel_whm_api_method_execute Read / Write Runs a WHM API method on any of your cPanel & WHM servers, with server administrator rights.

cPanel UAPI

These tools discover and run cPanel UAPI methods on behalf of a specific cPanel account:

Tool Access Description
si_cpanel_user_api_method_list Read Only Reads which cPanel UAPI methods are available, with a short summary of each.
si_cpanel_user_api_method_usage Read Only Describes what a specific cPanel UAPI method does and which parameters it expects.
si_cpanel_user_api_method_execute Read / Write Runs a cPanel UAPI method on behalf of a cPanel account.

Dashboard

These tools manage your WebPros Dashboard resources and API tokens:

Tool Access Description
dashboard_servers_list Read Only Reads the servers that you connected to the Dashboard, with the control panel and version of each.
dashboard_websites_list Read Only Reads the websites the Dashboard tracks and the servers hosting them.
dashboard_data_sync Read Only Refreshes the Dashboard data for the account’s servers and websites.
dashboard_api_tokens_list Read Only Reads the API tokens on your account and their details. This tool never shows token secrets.
dashboard_api_tokens_get Read Only Reads a single API token on your account and its details. This tool never shows the token secret.
dashboard_api_tokens_create Read / Write Creates a new API token for your account.
dashboard_api_tokens_delete Read / Write Permanently revokes an API token from your account. Any agent using this token loses access.
---