Skip to contents

Show publicly accessible server configuration.

Source: R/config_public.R
config_public.Rd

[Experimental]

Usage

config_public(
  url = get_default_url(),
  un = NULL,
  pw = NULL,
  retries = get_retries()
)

Arguments

url

The ODK Central base URL without trailing slash.

Default: get_default_url.

Set default url through ru_setup(url="...").

See vignette("Setup", package = "ruODK").

un

(character) The ODK Central username. Optional: the endpoint needs no authentication. Default: NULL (anonymous).

pw

(character) The ODK Central password. Optional: the endpoint needs no authentication. Default: NULL (anonymous).

retries

The number of attempts to retrieve a web resource.

This parameter is given to RETRY(times = retries).

Default: 3.

Value

A list with the public server configuration as per the ODK Central API docs.

Details

This endpoint returns all server configuration that is publicly accessible in a single object. This endpoint does not require authentication. The following configurations are publicly accessible: login-appearance, logo and hero-image. For configuration that stores binary data (e.g. logo), this endpoint only returns metadata about the configuration. This endpoint requires ODK Central 2026.1 or later.

See also

https://docs.getodk.org/central-api-system-endpoints/#getting-all-public-configuration

Other server-management: audit_get()

Examples

if (FALSE) { # \dontrun{
cfg <- config_public(url = "https://my.odkcentral.org")

names(cfg)
} # }