B.1. Remote check types

 B.1.1. remote.dns

 Summary

The remote.dns check will run a DNS check against a given target. This check should assist in verifying functionality of a DNS server, for example ensuring that it is publishing the domains you think that it should be publishing.

Table B.1. Attributes
FieldDescriptionValidation
query DNS Query
  • String

  • Valid hostname

record_type DNS Record Type
  • String matching the regex /^(A|AAAA|TXT|MX|SOA|CNAME|PTR|NS|MB|MD|MF|MG|MR)$/

port Port number (default: 53)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

Table B.2. Metrics
MetricDescriptionType
answerThe list of space seperated IP addresses for the specified name resolution.String
rttThe roundtrip time to execute a remote.dns check.Double
ttlThe TTL returned by the dns query.Uint32

 B.1.2. remote.ftp-banner

 Summary

The remote.ftp-banner check will attempt to connect to a FTP server and verify that it responds to the connection.

Table B.3. Attributes
FieldDescriptionValidation
port Port number (default: 21)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

Table B.4. Metrics
MetricDescriptionType
banner_matchThe matched string from the banner_match regular expression specified during check creation.String
durationThe time took to finish executing the check in milliseconds.Uint32
bannerThe string sent from the server on connect.String
tt_firstbyteThe time to first byte measured in milliseconds.Uint32
tt_connectThe time to connect measured in milliseconds.Uint32

 B.1.3. remote.http

 Summary

The remote.http check will try to connect to the server and retrieve the specified URL using the specified method, optionally with the password and user for authentication, using SSL, and checking the body with a regex. This can be used to test that a web application running on a server is responding without generating error messages. It can also test if the SSL certificate is valid.

Table B.5. Attributes
FieldDescriptionValidation
url Target URL
  • URL

  • String between 1 and 8096 characters long

auth_password Optional auth password
  • Optional

  • String between 1 and 255 characters long

auth_user Optional auth user
  • Optional

  • String between 1 and 255 characters long

body Body match regular expression (body is limited to 100k)
  • Optional

  • String between 1 and 255 characters long

body_matches Body match regular expressions (body is limited to 100k, matches are truncated to 80 characters)
  • Optional

  • Hash [String,String between 1 and 50 characters long,String matching the regex /^[-_ a-z0-9]+$/i:String,String between 1 and 255 characters long]

  • Array or object with number of items between 0 and 4

follow_redirects Follow redirects (default: true)
  • Optional

  • Boolean

headers Arbitrary headers which are sent with the request.
  • Optional

  • Hash [String,String between 1 and 50 characters long:String,String between 1 and 50 characters long]

  • Array or object with number of items between 0 and 10

  • A value which is not one of: content-length, user-agent, host, connection, keep-alive, transfer-encoding, upgrade

method HTTP method (default: GET)
  • Optional

  • String

  • One of (HEAD, GET, POST, PUT, DELETE, INFO)

payload Specify a request body (limited to 1024 characters). If following a redirect, payload will only be sent to first location
  • Optional

  • String between 0 and 1024 characters long

Table B.6. Metrics
MetricDescriptionType
cert_subjectThe subject of the certificate. This is only available performing a check on an HTTPS server.String
cert_endThe absolute timestamp in seconds for the certificate expiration. This is only available performing a check on an HTTPS server.Uint32
cert_startThe absolute timestamp of the issue of the certificate. This is only available performing a check on an HTTPS server.Uint32
cert_errorA string describing a certificate error in our validation. This is only available performing a check on an HTTPS server.String
truncatedThe number of bytes that the result was truncated.Uint32
bytesThe number of bytes returned from a response payload.Int32
cert_end_inThe relative timestamp in seconds til certification expiration. This is only available performing a check on an HTTPS server.Int32
codeThe status code returned.String
tt_connectThe time to connect measured in milliseconds.Uint32
durationThe time took to finish executing the check in milliseconds.Uint32
body_match_oneThe string representing a single body_matches value specified in a remote.http check. This metrics are only present when using a body_matches option. one is the actual key you have specified for the body_matches option.String
tt_firstbyteThe time to first byte measured in milliseconds.Uint32
body_match_twoThe string representing a single body_matches value specified in a remote.http check. This metrics are only present when using a body_matches option. two is the actual key you have specified for the body_matches option.String
body_matchThe string representing the body match specified in a remote.http check.String
cert_issuerThe issue string for the certificate. This is only available performing a check on an HTTPS server.String

 B.1.4. remote.imap-banner

 Summary

The remote.imap-banner check will attempt to connect to an IMAP server and verify that it response to the connection

Table B.7. Attributes
FieldDescriptionValidation
port Port number (default: 143)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean

 B.1.5. remote.mssql-banner

 Summary

The remote.mssql-banner check will attempt to connect to a Microsoft SQL database server and verify that it is accepting connections.

Table B.8. Attributes
FieldDescriptionValidation
port Port number (default: 1433)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean

 B.1.6. remote.mysql-banner

 Summary

The remote.mysql-banner check will attempt to connect to a MySQL database server and verify that it is accepting connections.

Table B.9. Attributes
FieldDescriptionValidation
port Port number (default: 3306)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean

 B.1.7. remote.ping

 Summary

The remote.ping check will attempt to ping a server.

Table B.10. Attributes
FieldDescriptionValidation
count Number of pings to send within a single check
  • Optional

  • Whole number (may be zero padded)

  • Value (1..15)

Table B.11. Metrics
MetricDescriptionType
availableThe whole number representing the percent of pings that returned back for a remote.ping check.Double
countThe number of ping ping's returned.Int32
averageThe average response time for all ping packets sent out and later retrieved.Double
minimumThe minimum roundtrip time of an ICMP packet.Double
maximumThe maximum roundtrip time of an ICMP packet.Double

 B.1.8. remote.pop3-banner

 Summary

The remote.pop3-banner check will attempt to connect to a POP3 mailbox server and verify that it responds to the connection.

Table B.12. Attributes
FieldDescriptionValidation
port Port number (default: 110)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean

 B.1.9. remote.postgresql-banner

 Summary

The remote.postgresql-banner check will attempt to connect to a PostgreSQL database server and verify that it is accepting connections.

Table B.13. Attributes
FieldDescriptionValidation
port Port number (default: 5432)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean

 B.1.10. remote.smtp-banner

 Summary

The remote.smtp-banner check will attempt to connect to a SMTP mail server and verify that a HELO/EHLO is received.

Table B.14. Attributes
FieldDescriptionValidation
port Port number (default: 25)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean

Table B.15. Metrics
MetricDescriptionType
banner_matchThe matched string from the banner_match regular expression specified during check creation.String
cert_endThe absolute timestamp in seconds for the certificate expiration. This is only available performing a check on an HTTPS server.Uint32
cert_startThe absolute timestamp of the issue of the certificate. This is only available performing a check on an HTTPS server.Uint32
cert_errorA string describing a certificate error in our validation. This is only available performing a check on an HTTPS server.String
cert_end_inThe relative timestamp in seconds til certification expiration. This is only available performing a check on an HTTPS server.Int32
durationThe time took to finish executing the check in milliseconds.Uint32
tt_connectThe time to connect measured in milliseconds.Uint32
tt_firstbyteThe time to first byte measured in milliseconds.Uint32
cert_subjectThe subject of the certificate. This is only available performing a check on an HTTPS server.String
bannerThe string sent from the server on connect.String
cert_issuerThe issue string for the certificate. This is only available performing a check on an HTTPS server.String

 B.1.11. remote.smtp

 Summary

The remote.smtp check will attempt to connect to a SMTP mail server, send an email from the 'from' parameter, to the 'to' parameter, with a payload specified by the 'payload' parameter setting the EHLO from host to the value in 'ehlo'

Table B.16. Attributes
FieldDescriptionValidation
ehlo EHLO parameter
  • Optional

  • String between 1 and 255 characters long

from From parameter
  • Optional

  • String between 1 and 255 characters long

payload Specifies the payload
  • Optional

  • String between 1 and 1024 characters long

port Port number (default: 25)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

starttls Should the connection be upgraded to TLS/SSL
  • Optional

  • Boolean

to To parameter (if blank, a "quit" is issued before sending a to line, and the connection is terminated)
  • Optional

  • String between 1 and 255 characters long

 B.1.12. remote.ssh

 Summary

The remote.ssh check will attempt to SSH to a target.

Table B.17. Attributes
FieldDescriptionValidation
port Port number (default: 22)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

Table B.18. Metrics
MetricDescriptionType
durationThe time took to finish executing the check in milliseconds.Uint32
fingerprintThe ssh fingerprint used to verify identity.String

 B.1.13. remote.tcp

 Summary

The remote.tcp check will attempt to connect to a host and port, and optionally issue a banner match to ensure that the service is responding as specified. This can be used to test services that are not covered by the existing HTTP, SMTP, SSH, MySQL, etc. checks.

Table B.19. Attributes
FieldDescriptionValidation
port Port number
  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

banner_match Banner match regex.
  • Optional

  • String between 1 and 255 characters long

body_match Body match regex. Key/Values are captured when matches are specified within the regex. Note: Maximum body size 1024 bytes.
  • Optional

  • String between 1 and 255 characters long

send_body Send a body. If a banner is provided the body is sent after the banner is verified.
  • Optional

  • String between 1 and 1024 characters long

ssl Enable SSL
  • Optional

  • Boolean

Table B.20. Metrics
MetricDescriptionType
banner_matchThe matched string from the banner_match regular expression specified during check creation.String
durationThe time took to finish executing the check in milliseconds.Uint32
bannerThe string sent from the server on connect.String
tt_firstbyteThe time to first byte measured in milliseconds.Uint32
tt_connectThe time to connect measured in milliseconds.Uint32

 B.1.14. remote.telnet-banner

 Summary

The remote.telnet-banner check will attempt to connect to a Telnet (or similar protocol) server and verify that an appropriate banner is received.

Table B.21. Attributes
FieldDescriptionValidation
banner_match Banner to check
  • Optional

  • String between 1 and 255 characters long

port Port number (default: 23)
  • Optional

  • Whole number (may be zero padded)

  • Integer between 1-65535 inclusive

ssl Enable SSL
  • Optional

  • Boolean



loading table of contents...