Nodalio API Technical Documentation

  1. Home
  2. Docs
  3. Nodalio API Technical Documentation
  4. API Overview

API Overview

This shortcode allows you to activate, deactivate or return the current status of the Nodalio REST API on your server. This API allows you to run Nodalio site approved shortcodes on your site.

To run Nodalio shortcodes on your server, please follow this guide.

Shortcode usage format:

  • sudo nodalio api on/off/status

Shortcode reference:

  • on/off/status – turn on/off Nodalio API. You may use status to find out if Nodalio API is active.

Available Site Approved Shortcodes:

  • cacheon
  • microcache
  • backuplist
  • sitemovetostaging
  • sitemovetolive
  • keepalive
  • appcl
  • cacheoff
  • oc
  • snapshot
  • sitelog-access
  • sitelog-access-staging
  • sitelog-error
  • sitelog-error-staging
  • siteinfo

API Usage Format:

http://serverip:34560/v1/sites/122334 (Currently supports POST requests only)

API Reference:

  • serverip – your server’s IP address.
  • 34560 – API port.
  • v1/sites – site shortcodes endpoint.
  • 122334 – your site’s ID.

Please note: the API allows you to run shortcodes on specific sites only, for security reasons, there is no option to list all site ids available on the server.

Shortcode format in the Nodalio Dashboard:

Shortcode result in the Nodalio Dashboard:

Was this article helpful to you? Yes No

How can we help?