Update NocoDB plugin configuration

Updates the configuration of the specified plugin on a NocoDB server via its PATCH /api/v1/db/meta/plugins/{id_plugin} API endpoint.

Usage

update_plugin(
  id_plugin,
  config = NULL,
  activate = NULL,
  hostname = pal::pkg_config_val("hostname"),
  email = pal::pkg_config_val("email"),
  password = pal::pkg_config_val("password"),
  api_token = pal::pkg_config_val("api_token")
)

Arguments

id_plugin

NocoDB plugin identifier as returned by plugin_id(). A character scalar.

config

Plugin configuration. A list or NULL. If NULL, the plugin's configuration is left untouched.

activate

Whether or not to activate the plugin. If NULL, the plugin's activation status is left untouched.

hostname

NocoDB server hostname. A character scalar.

email

E-mail address of the NocoDB user to authenticate with.

password

Password of the NocoDB user to authenticate with.

api_token

NocoDB API token. Takes precedence over email and password if provided.

Value

A tibble with metadata about the updated NocoDB plugin, invisibly.

See also

Other functions to manage NocoDB plugins: is_plugin_active(), plugin(), plugin_category(), plugin_id(), plugins(), test_plugin()

Examples

if (FALSE) { # \dontrun{
nocodb::update_plugin(id_plugin = nocodb::plugin_id(title = "Backblaze B2"),
                      config = list(region = "REPLACE-ME",
                                    bucket = "REPLACE-ME",
                                    access_key = "REPLACE-ME",
                                    access_secret = "REPLACE-ME"),
                      activate = TRUE)
                      
nocodb::update_plugin(id_plugin = nocodb::plugin_id(title = "S3"),
                      config = list(endpoint = "https://s3.REPLACE-ME.backblazeb2.com",
                                    region = "REPLACE-ME",
                                    bucket = "REPLACE-ME",
                                    access_key = "REPLACE-ME",
                                    access_secret = "REPLACE-ME",
                                    acl = "public-read"),
                      activate = TRUE)} # }