Skip to contents

Ping a BrAPI Server

Source: R/utils.R
brapi_ping.Rd

Tests whether the BrAPI server is reachable and responding.

Usage

brapi_ping(con, ...)

Arguments

con

A brapi_connection() object.

...

Additional query parameters.

Value

Logical, invisibly. TRUE if /serverinfo answers with HTTP 200 and a JSON body, or with 401/403 (the server is up but needs authentication); FALSE otherwise. The HTTP status is attached as the "status" attribute (NA if the server could not be reached).

Details

A ping uses a timeout of at most 10 seconds and doesn't retry, so an unreachable server is reported quickly.

BrAPI endpoint

GET /serverinfo - see the v2.1 specification.

Query parameters the specification defines, which may be passed through ...:

contentType, dataType.

Examples

# \donttest{
con <- brapi_connection("https://test-server.brapi.org")
brapi_ping(con)
#> ✔ Server <https://test-server.brapi.org> is reachable.
# }