API documentationΒΆ
The API documentation can be generated by running a script on the appliance and viewing the pages in a standard browser.
To generate the API documentation, follow these steps:
Open an SSH session to the appliance as the
beacon
user and elevate to root.Change directory to
/usr/beacon/www
.Run the following command:
# php artisan scribe:generate
Once the script has finished running, open the URL https://<appliance_ip>/docs
in any browser to view the API documentation pages.