Modules@robinpath/uptime
uptime

@robinpath/uptime

0.1.1Node.jsPublic

Uptime module for RobinPath.

Uptime

Uptime module for RobinPath.

Package: @robinpath/uptime | Category: Devops | Type: Integration

Authentication

No authentication required. All functions are available immediately.

Use Cases

Use the uptime module when you need to:

  • checkHttp -- Use uptime.checkHttp to perform this operation
  • checkHttps -- Use uptime.checkHttps to perform this operation
  • checkTcp -- Use uptime.checkTcp to perform this operation
  • checkDns -- Use uptime.checkDns to perform this operation
  • checkSslCertificate -- Use uptime.checkSslCertificate to perform this operation

Quick Reference

FunctionDescriptionReturns
checkHttpcheckHttpobject
checkHttpscheckHttpsobject
checkTcpcheckTcpobject
checkDnscheckDnsobject
checkSslCertificatecheckSslCertificateobject
batchCheckbatchCheckobject
getResponseTimegetResponseTimeobject
checkContentMatchcheckContentMatchobject
checkRedirectcheckRedirectobject
getHeadersgetHeadersobject
checkPortcheckPortobject
formatReportformatReportobject
comparePerformancecomparePerformanceobject
checkHealthcheckHealthobject

Functions

checkHttp

checkHttp

Module: uptime | Returns: object -- API response.

uptime.checkHttp
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkHttps

checkHttps

Module: uptime | Returns: object -- API response.

uptime.checkHttps
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkTcp

checkTcp

Module: uptime | Returns: object -- API response.

uptime.checkTcp
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkDns

checkDns

Module: uptime | Returns: object -- API response.

uptime.checkDns
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkSslCertificate

checkSslCertificate

Module: uptime | Returns: object -- API response.

uptime.checkSslCertificate
ParameterTypeRequiredDescription
inputstringNoInput parameter

batchCheck

batchCheck

Module: uptime | Returns: object -- API response.

uptime.batchCheck
ParameterTypeRequiredDescription
inputstringNoInput parameter

getResponseTime

getResponseTime

Module: uptime | Returns: object -- API response.

uptime.getResponseTime
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkContentMatch

checkContentMatch

Module: uptime | Returns: object -- API response.

uptime.checkContentMatch
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkRedirect

checkRedirect

Module: uptime | Returns: object -- API response.

uptime.checkRedirect
ParameterTypeRequiredDescription
inputstringNoInput parameter

getHeaders

getHeaders

Module: uptime | Returns: object -- API response.

uptime.getHeaders
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkPort

checkPort

Module: uptime | Returns: object -- API response.

uptime.checkPort
ParameterTypeRequiredDescription
inputstringNoInput parameter

formatReport

formatReport

Module: uptime | Returns: object -- API response.

uptime.formatReport
ParameterTypeRequiredDescription
inputstringNoInput parameter

comparePerformance

comparePerformance

Module: uptime | Returns: object -- API response.

uptime.comparePerformance
ParameterTypeRequiredDescription
inputstringNoInput parameter

checkHealth

checkHealth

Module: uptime | Returns: object -- API response.

uptime.checkHealth
ParameterTypeRequiredDescription
inputstringNoInput parameter

Error Handling

All functions throw on failure. Common errors:

ErrorCause
Uptime: "..." not configured. Call uptime.setCredentials first.Check the error message for details
@desc "Check http and validate result"
do
  set $result as uptime.checkHttp
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate ResponseTime

Retrieve all items and loop through them.

@desc "Get response time and iterate results"
do
  set $result as uptime.getResponseTime
  each $item in $result
    print $item
  end
enddo

2. Multi-step Uptime workflow

Chain multiple uptime operations together.

@desc "Check http, check https, and more"
do
  set $r_checkHttp as uptime.checkHttp
  set $r_checkHttps as uptime.checkHttps
  set $r_checkTcp as uptime.checkTcp
  print "All operations complete"
enddo

3. Safe checkHttp with validation

Check results before proceeding.

@desc "Check http and validate result"
do
  set $result as uptime.checkHttp
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

  • docker -- Docker module for complementary functionality
  • git -- Git module for complementary functionality
  • github -- GitHub module for complementary functionality
  • gitlab -- GitLab module for complementary functionality
  • vercel -- Vercel module for complementary functionality

Versions (1)

VersionTagPublished
0.1.1latest1 months ago
Install
$ robinpath add @robinpath/uptime

Collaborators

Dumitru Balaban
Dumitru Balaban
@dumitru
View all @robinpath modules
Version0.1.1
LicenseMIT
Unpacked Size3.6 KB
Versions1
Weekly Downloads21
Total Downloads21
Stars0
Last Publish1 months ago
Created1 months ago

Keywords

Category

devops