What Is the API For?

The Dotcom-Monitor API provides a structured, programmatic way to access Dotcom-Monitor’s monitoring and load-testing capabilities. It allows you to create and manage load tests, monitoring devices, tasks, locations, alerts, and retrieve status or performance data, etc.  — all through HTTP requests instead of the web interface.

When creating a Web API Integration (Manage > Integrations > New Integration), you must enable access to data outside your Dotcom-Monitor account. For details, see How to Whitelist IPs for Web API Access.

Base URL

All API endpoints use the following base URL:

https://api.dotcom-monitor.com/config_api_v1/
The service is available over both HTTP and HTTPS.

Authentication

Every request requires initial authentication. The session expires after 60 seconds of inactivity.

See the API Authentication section for full instructions.

You can allow Web API access for all authenticated requests or restrict access to trusted IP addresses only. Refer to How to Whitelist IPs for Web API Access for details.

MIME Types

The API uses JSON for both requests and responses.

Set the Content-Type: application/json header only when sending a JSON request body.

Methods

  • GET — all read operations
  • POST/PUT — all write or update operations

Errors

See the Error Handling article for details on how errors are returned and interpreted.

Using the API