circleHTTP: Circle CI HTTP Requests

In cloudyr/circleci: Circle CI API Client Package

Description

This is the workhorse function for executing API requests for Circle CI.

Usage

circleHTTP(verb = "GET", path = "", query = list(), body = "",
  base = "https://circleci.com/api/v1", key = Sys.getenv("CIRCLE_CI_KEY"),
  ...)

Arguments

verb	A character string containing an HTTP verb, defaulting to “GET”.
path	A character string with the API endpoint (should begin with a slash).
query	A list specifying any query string arguments to pass to the API.
body	character string of request body data.
base	A character string specifying the base URL for the API.
key	A character string containing a Circle CI API token. If missing, defaults to value stored in environment variable “CIRCLE_CI_KEY”.
...	Additional arguments passed to an HTTP request function, such as GET.

Details

This is mostly an internal function for executing API requests. In almost all cases, users do not need to access this directly.

Value

The JSON response, or the relevant error.

cloudyr/circleci documentation built on May 13, 2019, 8:20 p.m.