get.rds: Get RDS Server

View source: R/functions.R

get.rdsR Documentation

Get RDS Server

Description

This function uses the provided host, port, protocol, and application path to build up an RDS server. This will create the base paths that the server uses to build up future requests as well as pulling basic information about the server.

Usage

get.rds(host, port = NULL, protocol = "http", path = "rds", apiKey = NULL)

Arguments

host

The host or domain name of the server

port

The port the RDS server is running on if needed. This is NULL by default.

protocol

The protocol to use in the call, http by default.

path

The path to the RDS application root. This will be rds by default, if no path is desired (for instances behind a proxy) this can be set to null

apiKey

The user's apiKey to access the API, if the API is not secured this can be NULL.

Examples

get.rds("https://covid19.richdataservices.com/rds")

mtna/rds-r documentation built on July 30, 2023, 3:25 a.m.