API Updates: Retrieve Dedicated Server Status on Demand
LuxSci’s secure REST API enables LuxSci’s customers to automate account management activities, send secure email messages and secure texts, download custom reports, integrate their web sites with LuxSci WebMail using single sign on, and more.
As frequently happens, at LuxSci, we have added some more features to our API at the request of current customers. These are two new API calls related to dedicated servers. With these calls, you can take inventory of all of the dedicated servers that you gave with LuxSci (be that one or 20 or more) and then request the current status of each one. Additionally, we have updated our API documentation guides.
The API has two new functions for accessing information about dedicated servers. In order to use these functions, you will need to ensure that the configuration that you are using has the “Dedicated Servers – Servers Report” access control permission enabled. LuxSci’s API is designed with security in mind – existing configurations do not have permission to use significantly new/different features that are added over time until you explicitly grant such access.
Reports: All Servers
The first new command returns a current list of add dedicated servers assigned to your account. For each server this includes information such as the server name, unique Id, amount of RAM, number of CPU cores, etc. This is all static information; information not directly related to the current health and uptime of your server.
Report: Server Status
For any particular server in your account, you can request the server status. In addition to the static information about your server that you get from the all servers report, the server status report also includes the current values of:
- If the server is up and responding.
- How long since the server was last rebooted.
- The 1-minute, 5-minute, and 15-minute server load averages (divided by the number of CPU cores the server has).
- How much RAM and SWAP space is available and used.
- How much network bandwidth has been used in the last 15 minutes, inbound and outbound.
- Information about all mounted disks: How much space they have, how much is free, and what the current percentage I/O load is.
- How many email messages are in your outbound email queues.
Accessing the Application Programming Interface
To start using the API, customers should first review the API documentation. Then, proceed to the API section of your LuxSci account administration pages and create a configuration and assign what types of functions your API configuration should be permitted to perform.
If you have questions, please contact LuxSci support.