axprism_request: Make a raw request against the AxPrism API

View source: R/axprism.R

axprism_requestR Documentation

Make a raw request against the AxPrism API

Description

Generic escape hatch for any of the API's 165+ endpoints. Returns parsed JSON (a list). Honors retries/backoff and raises informative errors.

Usage

axprism_request(client, method, path, query = list(), body = NULL)

Arguments

client

An axprism_client.

method

HTTP method: "GET", "POST", or "DELETE".

path

Endpoint path beginning with /api/v1/....

query

Named list of query parameters (NULLs dropped).

body

Named list sent as a JSON request body (for POST).

Value

Parsed response (named list).

Examples

client <- axprism_client(api_key = "demo-key")
## Not run: 
# Requires network access and a valid API key.
axprism_request(client, "GET", "/api/v1/health")

## End(Not run)

axprism documentation built on July 8, 2026, 9:07 a.m.