The server endpoint allows server owners and system admins to control server configuration. For example: add/delete sites, manage backups etc..
This endpoint inherits all shortcodes from the /v1/sites endpoint and the shared /v1/tokenvalidate available for all API users.
The post request can accept 3 types of variables:
- Body variables
- URL query strings
- Request params
Each variable is formatted as follows:
| Key | Value |
| shortcode_name | cacheon |
| shortcode_action | opticache |
| shortcode_domain | test.nodalio.com |
To target a specific site please use the site’s primary domain inside the value in the key (no need to send the SiteID):
- shortcode_domain
Shortcodes available for the /v1/server endpoint:
- siteadd
- siteadd-https
- sitedelete
- sitelist
- aliasadd
- aliasadd-https
- siteconverthttps
- siteconverthttp
- siteconvertmultisite
- siteconvertsingle
- serverkey
- serveradmin-email
- sitediskchange
- backupfiles
- backupdisk
- snapshotlist
- restoresnapshot
- restoresnapshot-full
- databaselist
- databaseadd
- databaseadd-user
- databasedelete
- databasedelete-user
- databaseedit-user
- redirectadd
- redirectedit
- redirectdelete
- redirectlist
- aliasdelete
- snapshot-delete
- oc-delete – currently API only
- save_site_settings – special API only shortcode for bulk site-specific settings save.
- save_server_settings – special API only shortcode for bulk server-specific settings save.
Sites vs. Server API
The /v1/sites endpoint allows you to send API requests to a specific site, using the site ID as a url query string. For example, if – test.nodalio.com has the ID of 123abc :: The api request for it is SERVERIP:34560/v1/sites/123abc.
When sending a specific site request using the /v1/server endpoint, the site information is sent using the primary domain name (not the ID as in the sites api), using the value in the key shortcode_domain.