NodePing Elixir v1.1.4 API Reference
Modules
A module for handling generic NodePing functionality
Manage your NodePing account and subaccounts
Struct for creating a NodePing subaccount
Struct for updating a Nodeping account or subaccount
Create, read, update, and delete NodePing checks for your account and subaccounts
AGENT checks allow you to install a NodePing probe, installed and maintained by you and available only to your account, inside your private network that you can assign other NodePing checks to run on. For example, installing an AGENT on your LAN will allow you to create PING checks that can ensure internal devices are up and running in the 192.168.x.x address space.
The audio check can monitor your Icecast and SHOUTcast audio streaming services as well as most other audio streams to ensure they're available (up) and optionally test the stream for dead air (low volume).
The Cluster Check allows you to group interdependent NodePing checks in order to get notifications and track availability of the group of checks as a whole, in addition to each component check individually.
This check can do the following types of lookups: ANY, A, CNAME, MX, NS, PTR, SOA, and TXT. The NodePing checks also let you optionally look for specific information in the response sent back from the DNS server.
Use NodePing's DoH/DoT check to ensure your DoH or DoT services are up and replying to queries. The optional abilities to verify the SSL certificates, send EDNS(0) OPT pseudo-records, and use TLS client certificates makes our DoH/DoT check extremely capable.
The FTP check not only alerts you when your FTP service stops functioning properly but will also optionally alert you to the absence or presence of any particular file on the service.
You should use HTTP checks anytime you want to know if a web page is up and responding normally. However, HTTP checks just look at the status of the response, not at the actual content of what is returned.
HTTP Advanced Checks are very similar to HTTP and HTTP Content checks, except that HTTP Advanced checks provide additional features for those who need more granular control of either the request or the response verification.
HTTP Content Checks are very similar to HTTP Checks, except that HTTP Content checks look for a specific word (string) in the data returned in the response in addition to checking the status code and response time.
The check makes an HTTP GET call to a URL you specify and parses the JSON or text returned. It looks for fields you specify and then compares each value for those fields to an acceptable range you set for each. The check will PASS if the HTTP check returns a status code greater than 200 and less than 399 and all fields are present and within the ranges you specified.
IMAP monitoring is an important part of an overall email availability monitoring strategy. The checks can not only verify that your server is providing IMAP email retrieval properly but that user logins and your SSL/TLS certificates are also functioning properly.
Monitor the availability of a MySQL server
Use the NTP check when you want to monitor the uptime of your NTP servers or to receive alerts when private servers become publically available, as in the case of a failing firewall rule. The check can be configured to send you notifications if it's able to get a response or if it's not able to get a response.
You should use pings when you are checking availability of network devices like routers, and checking if a server is up independent of other services that are running on it. In some situations pings are preferable to HTTP checks because HTTP checks might appear in some statistics systems as hits on the web site.
POP monitoring is an important part of an overall email availability monitoring strategy. The checks can not only verify that your server is providing POP email retrieval properly but that user logins and your SSL/TLS certificates are also functioning properly.
The Port Connect check performs a simple TCP network connect call on any port you specify. It's protocol agnostic and can be used against any number of TCP network services. It simply reports if a connection was possible or not. The check can be configured to send you notifications if it is able to connect or if it is unable to connect.
PUSH checks allow you to send heartbeats and metrics from your servers to NodePing. Use a PUSH check for things like monitoring your servers that are behind firewalls, tracking CPU load on your Windows SQL servers, or getting alerts before you run out of disk space on your web servers.
RBL checks should be run for all servers that send email - including SMTP and web servers - on at least a daily basis. RBL check can test any ipv4 address or FQDN.
Monitor an RDP service to see if it is accessible
NodePing's SIP monitoring can verify that your SIP server is responding to new requests. The check does not initiate a call, but rather tests that the the server accepts a SIP connection by sending the OPTIONS command and watching for the response. Even if your server does not support the OPTIONS command and returns an error, this indicates that the server is up and operating, so the check succeeds.
NodePing's SMTP checks are an important part of an overall server monitoring strategy. The checks can not only verify that your server is accepting email properly but that user logins and your SSL/TLS certificates are also functioning properly. You can check to make sure that your SMTP server is not an open relay.
NodePing's SNMP checks support SNMPv1 and SNMPv2c and can track and alert on numeric OID return values, comparing them to a range. If the return value is less than or greater than your configured range, the check will fail and alerts will be sent.
The Spec10DNS check (S10DNS) is designed to monitor DNS to the ICANN Registry Agreement, specification 10 requirements. It needs 20+ regular NodePing DNS checks configured for 20+ locations running at 1 minute intervals.
The Spec10RDDS check (S10RDDS) is designed to monitor WHOIS availability to the ICANN Registry Agreement, specification 10 requirements. It needs 10+ NodePing WHOIS or HTTP Content checks configured for 10+ locations running at 5 minute intervals.
NodePing's SSH checks can be used to ensure the availability of your SSH services. In addition, the check can be configured with optional response string matching that, when used in conjunction with a login script, can provide notifications for things like CPU utilization, memory availability, or disk usage.
NodePing's SSL checks are an important part of your secure server monitoring strategy. The check can be used to ensure the validity of your SSL certificates, ensure that your web servers are handling the certificate correctly, and warn you well before your certificates expire, giving you time to renew them.
WebSocket checks should be used to monitor the availability of WebSocket services. It can optionally send a string 'message' to the websocket as part of the check and also verify that any return data either contains or does not contain a particular text. For instance, you can have the WebSocket check send 'mycustomcall' to your WebSocket service and verify that the response from service contains 'you must log in'.
WHOIS Checks should be use to receive alerts before your domain expires. They should also be used to ensure your domain registrar has the proper nameservers configured for your domain. You can also use it to verify that your administrative and technical contacts haven't been tampered with (hijacked).
Manage contact groups on your NodePing account and subaccout.
Manage contacts on your NodePing account and subaccount.
Struct for defining variables when creating a contact
Request diagnostic information from a probe or AGENT
Helper functions for the inner workings of of elixir library for the NodePing API
GET/POST/PUT/DELETE functions for interfacing with the NodePing API
Get information about NodePing probes and regions
Maintenance schedules are used for automating the disabling and re-enabling of checks on a schedule or for one-time use (ad-hoc). In the web site they are under Account Settings -> Maintenance.
Get notifications for your checks
Get check results and uptime information
Schedules are used for setting time windows for notifications. This module manages schedules for your account/subaccounts