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.

You can also use the XML feed for subscribing to monitoring data and presenting it in your own format. See Using the XML Reporting Service (XRS) Tool for details.

The Dotcom-Monitor API users can create their own custom scripts or applications to interact with the settings and view the monitored data in their own customized environment. Our system uses REST API that enables interaction with the Dotcom-Monitor web site programmatically using the most popular methods for working with data via HTTP(S) requests (GET, POST, PUT, DELETE). Almost all Dotcom-Monitor objects can be accessed via REST API and almost every aspect of Dotcom-Monitor service functionality can be managed. Using API calls the developers can create and remove devices and tasks, postpone and start them, create and manage alert groups, templates, filters and schedulers, obtain device status information plus many other options.

In general, the Dotcom-Monitor API can be used for the following tasks:

  • Third-party integration with the Dotcom-Monitor Monitoring solution.
  • Data download and upload.
  • Data modification.

The most common actions executed via the REST API:

  • Accessing lists of monitoring platforms, devices, targets, schedulers, locations, alert groups, filters, alert templates.
  • Accessing detailed info on platforms, devices and targets.
  • Editing devices, targets, schedulers, alert groups and templates, filters.
  • Creating a new dotcom-Monitor object ( devices, targets, schedulers, etc.).
  • Managing audit objects.

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