ping: Pings the PEcAn API server to see if it is live

View source: R/ping.R

pingR Documentation

Pings the PEcAn API server to see if it is live

Description

Pings the PEcAn API server (using the URL passed in the server object) to see if it is live or not. Hits the ⁠/api/ping⁠ API endpoint

Usage

ping(server)

Arguments

server

Server object obtained using the connect() function

Value

Response obtained from the ⁠/api/ping⁠ endpoint

Author(s)

Tezan Sahu

Examples

server <- connect(url="http://pecan.localhost:80", username="carya", password="illinois")
res <- ping(server)

PecanProject/rpecanapi documentation built on April 2, 2024, 8:17 a.m.