1. Home
  2. API
  3. API Documentation
  4. Snapt Aria Web Accelerator API Documentation

Snapt Aria Web Accelerator API Documentation

Please ensure you have read the beginners guide in order to understand the commands below.

All commands are sent to the snaptNginx module. Below is an example URL string for the Snapt Aria Web Accelerator:

http://localhost:8080/api/xxx-xxx-xxx-xxx/SNPxxxxxxxxx/snaptNginx

Common Commands for Snapt Aria Web Accelerator

The most common Website Accelerator commands are available below. You can call system.listMethods to see a detailed list of all the available methods.

Stats

Statistics and runtime information can be fetched with the snaptNginx.getStatusPage command. Seen below in Python:

print(str(proxy.snaptNginx.getStatusPage()));
<span style="font-size: 12.8000001907349px; line-height: 1.5; background-color: #f4f4f4;">{'reading': '0', 'handled': '3', 'writing': '1', 'waiting': '0', 'active': '1', 'requests': '3', 'accepted': '3'}</span>

Applying Changes

To restart you can issue the snaptNginx.reconfigure call. You can check if it needs a restart by sending the snaptNginx.needRestart call.

Additional Commands

You can see all the available commands by sending a system.listMethods() call to the snaptNginx API –

Command List

system.listMethods

Get a list of the methods available.

system.methodHelp 

Get help on a specific method, it’s usage etc.

snaptNginx.isRunning

Check if the Website Accelerator is currently running.

snaptNginx.needRestart

Marker of whether you need to restart the Website Accelerator to apply recent changes.

snaptNginx.reconfigure

Do a live reload of the config

snaptNginx.stop

Stop the Website Accelerator from running

snaptNginx.start

Start the Website Accelerator if it is not running

Please also refer to the developers section of this site for further documentation.

Updated on March 18, 2020


Was this article helpful?

Related Articles