Manage and secure all your Joomla! & WordPress websites with ease
in a single dashboard for only $1/site/month or less

Try for free

30 days. No Credit Card.
No commitment.

Buy now

Start to manage all
your websites.

Main Support

How do I use the Watchful REST API?

Users on all plans can use the REST (API) to query and update their Watchful data. Please review this video before proceeding:

 

Note: To test the API, please visit the interactive documentation.

Four HTTP verbs are supported:

  • GET requests to retrieve information
  • POST to add new records
  • PUT to update records
  • DELETE requests to remove records

API endpoint

All API requests must be made over HTTPS to the following endpoint:

https://app.watchful.li/api/v1

Calls made over plain HTTP will be redirected to HTTPS.

The API version is shown in the URLs of the endpoint, e.g. /api/v1.

Resources

You will find all the resources of the API on our interactive documentation.

API keys

To use the API with your Watchful account, select the API tab in your Profile and click the Request new API key button as shown in the screenshot below.

12-api-key

Authentication

You have three different methods to authenticate yourself to the API:

  1. HTTP Header
  2. Query parmeter
    • API Key in the query string
    • GET https://app.watchful.li/api/v1/sites?api_key=6a7c274802f2344196b44c
  3. Session Login
    • You can access to all the resources  if you are logged into Watchful . To use your session login, just provide your user name and password at the login screen and then make a request through your browser or with the interactive documenation.

Formats

Date and time values are of the form YYYY-MM-DD HH:MM:SS.

Booleans are either 1 (true) or 0 (false).

Search fields can use % like in SQL and a “!” before the the value for "not".

Inputs are always in JSON.

We support 4 differents format for output. If you don’t specify an accept header, the API will return JSON format by default:

  • XML
    • HTTP-Header Accept: application/xml
  • JSON
    • HTTP-Header Accept: application/json
  • JSONP
    • HTTP-Header Accept: application/json
    • For JSONP, add the ?callback parameter to any GET call to have the results wrapped in a JSON function. For example: https://app.watchful.li/api/v1/sites?callback=myfunction
  • Serialized
    • HTTP-Header Accept: text/plain

Errors

All status types can be views in the interactive documentation.

Examples:

  • XML return
  • JSON return

Calls per day

We currently restrict your API usage to 2000 requests per day. Please open a support ticket if you need more calls.

PHP examples

Why use Watchful?

You manage your websites manually.

You manage your websites manually.
We started like that! But our spreadsheets and reminders quickly became very complicated. We designed Watchful to simplify website management and actually make it pleasant experience.
Kristoffer Sandven
Watchful.li saves me from manually monitoring dozens of websites - I can keep them updated with just a few clicks from a single, slick interface!
Kristoffer Sandven / joomlablogger.net

Learn more about Remote Installer

You don’t offer maintenance plans for your customers.

You don’t offer maintenance plans for your customers.
Maintenance plans are a key way most agencies generate recurring revenue and keep in regular contact with their clients. With Watchful you can offer professional maintenance plans and deliver white-label reports to show your clients the value of your work.
Martijn Boomsma
Watchful keeps us on track with updates and maintenance tasks so our clients sites are always monitored and up-to-date.
Martijn Boomsma / perfectwebteam.com

Learn more about White-Label Reports

It takes you days to update all your sites.

It takes you days to update all your sites.
Logging into websites and individually applying software updates is time-consuming and error-prone. With Watchful, we let you know what updates are available and help you apply updates across all your sites at the same time.
Jonathan Frewin
Watchful cut my monthly [maintenance] time down from days to hours.
Jonathan Frewin / frewindesign.co.uk
Learn more about Backup Manager

You use WordPress and Joomla! in your agency.

You use WordPress and Joomla! in your agency.
Watchful works seamlessly with the two most popular website softwares: Wordpress and Joomla. And the list of supported applications is growing.
Matthew Philogene
Watchful.li provides a great overview of all our projects. Great support, great tools, cannot live without!
Matthew Philogene / raramuridesign.com

Learn more about Multi CMS dashboard

You don’t check your websites for security problems or backups.

You don’t check your websites for security problems or backups.
Watchful helps you monitor industry-accepted best-practices and potential security issues. And if a problem arises, Watchful’s customer support is there to help you understand the problem and advise you on possible solutions.
Joe Sonne
Using Watchful is far better than having to deal with a hacked website because a site fell behind in security updates.
Joe Sonne / joejoomla.com

Learn more about Site Audit

Watchful News and CMS Blog

WordPress support officially launches for Watchful - the webmasters toolbox

24 March 2017 / News

Effective immediately, Watchful now officially supports backups, updates, monitoring, and maintenance for websites powered by WordPress.

Preparations for migration to Amazon Web Services nearly complete

14 March 2017 / News

In the coming weeks, we plan to migrate our infrastructure from WiredTree to Amazon Web Service (AWS).

All News