@robinpath/uptime
0.1.1Node.jsPublicUptime 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.checkHttpto perform this operation - checkHttps -- Use
uptime.checkHttpsto perform this operation - checkTcp -- Use
uptime.checkTcpto perform this operation - checkDns -- Use
uptime.checkDnsto perform this operation - checkSslCertificate -- Use
uptime.checkSslCertificateto perform this operation
Quick Reference
| Function | Description | Returns |
|---|---|---|
checkHttp | checkHttp | object |
checkHttps | checkHttps | object |
checkTcp | checkTcp | object |
checkDns | checkDns | object |
checkSslCertificate | checkSslCertificate | object |
batchCheck | batchCheck | object |
getResponseTime | getResponseTime | object |
checkContentMatch | checkContentMatch | object |
checkRedirect | checkRedirect | object |
getHeaders | getHeaders | object |
checkPort | checkPort | object |
formatReport | formatReport | object |
comparePerformance | comparePerformance | object |
checkHealth | checkHealth | object |
Functions
checkHttp
checkHttp
Module: uptime | Returns: object -- API response.
uptime.checkHttp
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkHttps
checkHttps
Module: uptime | Returns: object -- API response.
uptime.checkHttps
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkTcp
checkTcp
Module: uptime | Returns: object -- API response.
uptime.checkTcp
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkDns
checkDns
Module: uptime | Returns: object -- API response.
uptime.checkDns
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkSslCertificate
checkSslCertificate
Module: uptime | Returns: object -- API response.
uptime.checkSslCertificate
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
batchCheck
batchCheck
Module: uptime | Returns: object -- API response.
uptime.batchCheck
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
getResponseTime
getResponseTime
Module: uptime | Returns: object -- API response.
uptime.getResponseTime
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkContentMatch
checkContentMatch
Module: uptime | Returns: object -- API response.
uptime.checkContentMatch
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkRedirect
checkRedirect
Module: uptime | Returns: object -- API response.
uptime.checkRedirect
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
getHeaders
getHeaders
Module: uptime | Returns: object -- API response.
uptime.getHeaders
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkPort
checkPort
Module: uptime | Returns: object -- API response.
uptime.checkPort
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
formatReport
formatReport
Module: uptime | Returns: object -- API response.
uptime.formatReport
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
comparePerformance
comparePerformance
Module: uptime | Returns: object -- API response.
uptime.comparePerformance
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
checkHealth
checkHealth
Module: uptime | Returns: object -- API response.
uptime.checkHealth
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
Error Handling
All functions throw on failure. Common errors:
| Error | Cause |
|---|---|
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)
| Version | Tag | Published |
|---|---|---|
| 0.1.1 | latest | 1 months ago |
Related Modules
github
JS@robinpathv0.1.1
GitHub module for RobinPath.
bitbucket
JS@robinpathv0.1.2
Bitbucket module for RobinPath.
box
JS@robinpathv0.1.2
Box module for RobinPath.
cache
JS@robinpathv0.1.2
In-memory key-value cache with optional TTL expiration for temporary data storage
$ robinpath add @robinpath/uptime
