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.

Value

Logical. TRUE if the server responds, FALSE otherwise.

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.
# }