Package 'connectapi'

Description

Usage

audit_access_open(content, type = "all")

Arguments

See Also

Other audit functions: audit_r_versions(), audit_runas(), vanity_is_available()

Description

Usage

audit_r_versions(content)

Arguments

Value

A plot that shows the R version used by content over time and in aggregate.

See Also

Other audit functions: audit_access_open(), audit_runas(), vanity_is_available()

Description

Usage

audit_runas(content)

Arguments

Value

A data frame with the app name and the Run As user if the Run As user is not the default

See Also

Other audit functions: audit_access_open(), audit_r_versions(), vanity_is_available()

Description

Browse to different locations on Connect via utils::browseURL

Usage

browse_solo(content)

browse_dashboard(content)

browse_api_docs(connect)

browse_connect(connect)

Arguments

Value

The url that is opened in the browser

Description

Bundle

Bundle

Details

An R6 class that represents a bundle

Public fields

Methods

Public methods

• Bundle$new()

• Bundle$print()

• Bundle$clone()

Method new()

Initialize this content bundle.

Usage

Bundle$new(path)

Arguments

Method print()

Print this object.

Usage

Bundle$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Bundle$clone(deep = FALSE)

Arguments

See Also

Other R6 classes: Content, ContentTask, Environment, PositConnect, Task, Vanity, Variant, VariantSchedule, VariantTask

Description

Creates a bundle from a target directory.

Usage

bundle_dir(
  path = ".",
  filename = fs::file_temp(pattern = "bundle", ext = ".tar.gz")
)

Arguments

Value

Bundle A bundle object

See Also

Other deployment functions: bundle_path(), bundle_static(), deploy(), download_bundle(), poll_task()

Examples

bundle_dir(system.file("tests/testthat/examples/shiny/", package = "connectapi"))

Description

Define a bundle from a path (a path directly to a tar.gz file)

Usage

bundle_path(path)

Arguments

Value

Bundle A bundle object

See Also

Other deployment functions: bundle_dir(), bundle_static(), deploy(), download_bundle(), poll_task()

Examples

bundle_path(system.file("tests/testthat/examples/static.tar.gz", package = "connectapi"))

Description

Defines a bundle from static files. It copies all files to a temporary directory, generates a basic manifest file (using the first file as the "primary"), and bundles the directory.

Usage

bundle_static(
  path,
  filename = fs::file_temp(pattern = "bundle", ext = ".tar.gz")
)

Arguments

Details

NOTE: the rsconnect package is required for this function to work properly.

Value

Bundle A bundle object

See Also

Other deployment functions: bundle_dir(), bundle_path(), deploy(), download_bundle(), poll_task()

Examples

bundle_static(system.file("logo.png", package = "connectapi"))

Description

Creates a connection to Posit Connect using the server URL and an api key. Validates the connection and checks that the version of the server is compatible with the current version of the package.

Usage

connect(
  server = Sys.getenv(paste0(prefix, "_SERVER"), NA_character_),
  api_key = Sys.getenv(paste0(prefix, "_API_KEY"), NA_character_),
  prefix = "CONNECT",
  ...,
  .check_is_fatal = TRUE
)

Arguments

Value

A Posit Connect R6 object that can be passed along to methods

Examples

## Not run: 
connect()

## End(Not run)



# default is to read CONNECT_SERVER and CONNECT_API_KEY environment variables
# this example will read TEST_1_SERVER and TEST_1_API_KEY
connect(prefix = "TEST_1")

Description

Content

Content

Details

An R6 class that represents content

Public fields

Active bindings

Methods

Public methods

• Content$new()

• Content$get_connect()

• Content$get_content()

• Content$get_content_remote()

• Content$get_bundles()

• Content$bundle_download()

• Content$bundle_delete()

• Content$internal_content()

• Content$update()

• Content$danger_delete()

• Content$get_url()

• Content$get_dashboard_url()

• Content$jobs()

• Content$job()

• Content$variants()

• Content$tag_set()

• Content$tag_delete()

• Content$tags()

• Content$permissions_add()

• Content$permissions_update()

• Content$permissions_delete()

• Content$permissions()

• Content$environment()

• Content$environment_set()

• Content$environment_all()

• Content$deploy()

• Content$repo_enable()

• Content$repo_set()

• Content$print()

• Content$clone()

Method new()

Initialize this content.

Usage

Content$new(connect, content)

Arguments

Method get_connect()

Returns the Connect instance.

Usage

Content$get_connect()

Method get_content()

Returns the underlying content data.

Usage

Content$get_content()

Method get_content_remote()

Obtain the content data from the Connect server.

Usage

Content$get_content_remote()

Method get_bundles()

Return the set of content bundles.

Usage

Content$get_bundles()

Method bundle_download()

Download the source archive for a content bundle.

Usage

Content$bundle_download(
  bundle_id,
  filename = tempfile(pattern = "bundle", fileext = ".tar.gz"),
  overwrite = FALSE
)

Arguments

Method bundle_delete()

Delete a content bundle.

Usage

Content$bundle_delete(bundle_id)

Arguments

Method internal_content()

Get this (remote) content item.

Usage

Content$internal_content()

Method update()

Update this content item.

Usage

Content$update(...)

Arguments

Method danger_delete()

Delete this content item.

Usage

Content$danger_delete()

Method get_url()

Return the URL for this content.

Usage

Content$get_url()

Method get_dashboard_url()

Return the URL for this content in the Posit Connect dashboard.

Usage

Content$get_dashboard_url(pane = "")

Arguments

Method jobs()

Return the jobs for this content.

Usage

Content$jobs()

Method job()

Return a single job for this content.

Usage

Content$job(key)

Arguments

Method variants()

Return the variants for this content.

Usage

Content$variants()

Method tag_set()

Set a tag for this content.

Usage

Content$tag_set(tag_id)

Arguments

Method tag_delete()

Remove a tag for this content.

Usage

Content$tag_delete(tag_id)

Arguments

Method tags()

The tags for this content.

Usage

Content$tags()

Method permissions_add()

Add a principal to the ACL for this content.

Usage

Content$permissions_add(principal_guid, principal_type, role)

Arguments

Method permissions_update()

Alter a principal in the ACL for this content.

Usage

Content$permissions_update(id, principal_guid, principal_type, role)

Arguments

Method permissions_delete()

Remove an entry from the ACL for this content.

Usage

Content$permissions_delete(id)

Arguments

Method permissions()

Obtain some or all of the ACL for this content.

Usage

Content$permissions(id = NULL, add_owner = FALSE)

Arguments

Method environment()

Return the environment variables set for this content.

Usage

Content$environment()

Method environment_set()

Adjust the environment variables set for this content.

Usage

Content$environment_set(...)

Arguments

Method environment_all()

Overwrite the environment variables set for this content.

Usage

Content$environment_all(...)

Arguments

Method deploy()

Deploy this content

Usage

Content$deploy(bundle_id = NULL)

Arguments

Method repo_enable()

Adjust Git polling.

Usage

Content$repo_enable(enabled = TRUE)

Arguments

Method repo_set()

Adjust Git repository.

Usage

Content$repo_set(repository, branch, subdirectory)

Arguments

Method print()

Print this object.

Usage

Content$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Content$clone(deep = FALSE)

Arguments

See Also

Other R6 classes: Bundle, ContentTask, Environment, PositConnect, Task, Vanity, Variant, VariantSchedule, VariantTask

Description

Delete a content item. WARNING: This action deletes all history, configuration, logs, and resources about a content item. It cannot be undone.

Usage

content_delete(content, force = FALSE)

Arguments

Value

The R6 Content item. The item is deleted, but information about it is cached locally

See Also

Other content functions: content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Returns a single content item based on guid

Usage

content_item(connect, guid)

Arguments

Value

A Content object for use with other content endpoints

See Also

Other content functions: content_delete(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Examples

## Not run: 
connect() %>%
  content_item("some-guid") %>%
  content_update_access_type("all")

## End(Not run)

Description

Get a content list

Usage

content_list_by_tag(src, tag)

Arguments

Details

content_list_by_tag() retrieves a content list by tag

Description

These functions are experimental placeholders until the API supports this behavior.

Usage

content_list_with_permissions(src, ..., .p = NULL)

content_list_guid_has_access(content_list, guid)

Arguments

Details

content_list_with_permissions loops through content and retrieves permissions for each item (with a progress bar). This can take a long time for lots of content! Make sure to use the optional .p argument as a predicate function that filters the content list before it is transformed.

content_list_guid_has_access works with a content_list_with_permissions dataset by checking whether a given GUID (either user or group) has access to the content by:

• checking if the content has access_type == "all"

• checking if the content has access_type == "logged_in"

• checking if the provided guid is the content owner

• checking if the provided guid is in the list of content permissions (in the "permissions" column)

Description

Submit a request to render a content item. Once submitted, the server runs an asynchronous process to render the content. This might be useful if content needs to be updated after its source data has changed, especially if this doesn't happen on a regular schedule.

Only valid for rendered content (e.g., most Quarto documents, Jupyter notebooks, R Markdown reports).

Usage

content_render(content, variant_key = NULL)

Arguments

Value

A VariantTask object that can be used to track completion of the render.

Examples

## Not run: 
client <- connect()
item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
task <- content_render(item)
poll_task(task)

## End(Not run)

Description

Submit a request to restart a content item. Once submitted, the server performs an asynchronous request to kill all processes associated with the content item, starting new processes as needed. This might be useful if the application relies on data that is loaded at startup, or if its memory usage has grown over time.

Note that users interacting with certain types of applications may have their workflows interrupted.

Only valid for interactive content (e.g., applications, APIs).

Usage

content_restart(content)

Arguments

Examples

## Not run: 
client <- connect()
item <- content_item(client, "8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0")
content_restart(item)

## End(Not run)

Description

Return content title for a piece of content. If the content is missing (deleted) or not visible, then returns the default

Usage

content_title(connect, guid, default = "Unknown Content")

Arguments

Value

character. The title of the requested content

See Also

Other content functions: content_delete(), content_item(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Update settings for a content item. For a list of all settings, see the latest documentation or the documentation for your server via connectapi::browse_api_docs().

Usage

content_update(content, ...)

content_update_access_type(content, access_type = c("all", "logged_in", "acl"))

content_update_owner(content, owner_guid)

Arguments

Details

Popular selections are content_update(access_type="all"), content_update(access_type="logged_in") or content_update(access_type="acl"), process settings, title, description, etc.

• content_update_access_type() is a helper to make it easier to change access_type

• content_update_owner() is a helper to make it easier to change owner

Value

An R6 content item

See Also

Other content functions: content_delete(), content_item(), content_title(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

ContentTask

ContentTask

Details

An R6 class that represents a Task for a piece of Content

Super class

connectapi::Content -> ContentTask

Public fields

Methods

Public methods

• ContentTask$new()

• ContentTask$get_task()

• ContentTask$add_data()

• ContentTask$get_data()

• ContentTask$print()

• ContentTask$clone()

Method new()

Initialize this task.

Usage

ContentTask$new(connect, content, task)

Arguments

Method get_task()

Return the underlying task.

Usage

ContentTask$get_task()

Method add_data()

Set the data.

Usage

ContentTask$add_data(data)

Arguments

Method get_data()

Get the data.

Usage

ContentTask$get_data()

Method print()

Print this object.

Usage

ContentTask$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

ContentTask$clone(deep = FALSE)

Arguments

See Also

Other R6 classes: Bundle, Content, Environment, PositConnect, Task, Vanity, Variant, VariantSchedule, VariantTask

Description

Creates a random name from the LETTERS dataset

Usage

create_random_name(length = 25)

Arguments

Value

The randomly generated name

See Also

connectapi::verify_content_name

Other content functions: content_delete(), content_item(), content_title(), content_update(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Returns the URL for the content dashboard (opened to the selected pane).

Usage

dashboard_url(content, pane = "")

Arguments

Value

character The dashboard URL for the content provided

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Returns the URL for the content dashboard (opened to the selected pane). NOTE: this takes a character object for performance optimization.

Usage

dashboard_url_chr(connect_url, content_guid, pane = "")

Arguments

Value

character The dashboard URL for the content provided

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Delete a runtime cache from a Connect server. Requires Administrator privileges.

Usage

delete_runtime_cache(
  client,
  language,
  version,
  image_name = "Local",
  dry_run = FALSE
)

Arguments

Value

A Task object representing the deletion task. If dry_run is TRUE, returns NULL or throws an error if the deletion would fail.

See Also

get_runtime_caches()

Other server management functions: get_runtime_caches()

Examples

## Not run: 
client <- connect()
task <- delete_runtime_cache(client, "R", "4.3.3")
poll_task(task)

## End(Not run)

Description

Delete the thumbnail from a content item on Connect.

Usage

delete_thumbnail(content)

Arguments

Value

The content item (invisibly).

See Also

Other thumbnail functions: get_thumbnail(), has_thumbnail(), set_thumbnail()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Examples

## Not run: 
client <- connect()
item <- content_item(client, "8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0")
thumbnail <- get_thumbnail(item)

## End(Not run)

Description

Deletes the Vanity URL for a piece of content.

Usage

delete_vanity_url(content)

Arguments

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Deploys a bundle (tarball) to an Posit Connect server. If not provided, name (a unique identifier) will be an auto-generated alphabetic string. If deploying to an existing endpoint, you can set name or guid to the desired content.

Usage

deploy(
  connect,
  bundle,
  name = create_random_name(),
  title = name,
  guid = NULL,
  ...,
  .pre_deploy = {
 }
)

deploy_current(content)

Arguments

Details

This function accepts the same arguments as connectapi::content_update().

deploy_current() is a helper to easily redeploy the currently active bundle for an existing content item.

Value

Task A task object

See Also

connectapi::content_update

Other deployment functions: bundle_dir(), bundle_path(), bundle_static(), download_bundle(), poll_task()

Examples

## Not run: 
client <- connect()

# beware bundling big directories, like `renv/`, `data/`, etc.
bnd <- bundle_dir(".")

deploy(client, bnd)

## End(Not run)


client <- connect(prefix = "TEST_1")
bnd <- bundle_path(system.file("tests/testthat/examples/static.tar.gz", package = "connectapi"))
deploy(client, bnd)

Description

Deploy a git repository directly to Posit Connect, using Posit Connect's "pull-based" "git-polling" method of deployment.

Usage

deploy_repo(
  client,
  repository,
  branch,
  subdirectory,
  name = create_random_name(),
  title = name,
  ...
)

deploy_repo_enable(content, enabled = TRUE)

deploy_repo_update(content)

Arguments

Details

• deploy_repo_enable() enables (or disables) Posit Connect's git polling for a piece of content

• deploy_repo_update() triggers an update of the content from its git repository, if any are present

Value

A ContentTask object, for use with poll_task() (if you want to follow the logs)

See Also

connectapi::poll_task, connectapi::repo_check_branches, connectapi::repo_check_manifest_dirs

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Downloads a Content item's active bundle, or (optionally) one of its other bundles.

Usage

download_bundle(
  content,
  filename = fs::file_temp(pattern = "bundle", ext = ".tar.gz"),
  bundle_id = NULL,
  overwrite = FALSE
)

Arguments

Value

Bundle A bundle object

See Also

Other deployment functions: bundle_dir(), bundle_path(), bundle_static(), deploy(), poll_task()

Description

Environment

Environment

Details

An R6 class that represents a Content's Environment Variables

Super class

connectapi::Content -> Environment

Public fields

Methods

Public methods

• Environment$new()

• Environment$environment()

• Environment$environment_set()

• Environment$environment_all()

• Environment$env_refresh()

• Environment$print()

• Environment$clone()

Method new()

Initialize this set of environment variables.

Usage

Environment$new(connect, content)

Arguments

Method environment()

Fetch the set of environment variables.

Usage

Environment$environment()

Method environment_set()

Update the set of environment variables.

Usage

Environment$environment_set(...)

Arguments

Method environment_all()

Overwrite the set of environment variables.

Usage

Environment$environment_all(...)

Arguments

Method env_refresh()

Fetch the set o environment variables.

Usage

Environment$env_refresh()

Method print()

Print this object.

Usage

Environment$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Environment$clone(deep = FALSE)

Arguments

See Also

Other R6 classes: Bundle, Content, ContentTask, PositConnect, Task, Vanity, Variant, VariantSchedule, VariantTask

Description

Get Audit Logs from Posit Connect Server

Usage

get_audit_logs(src, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/audit_logs for more information.

Value

A tibble with the following columns:

• id: ID of the audit action

• time: Timestamp in RFC3339 format when action was taken

• user_id: User ID of the actor who made the audit action

• user_description: Description of the actor

• action: Audit action taken

• event_description: Description of action

Examples

## Not run: 
library(connectapi)
client <- connect()

# get the last 20 audit logs
get_audit_logs(client, limit = 20, asc_order = FALSE)

## End(Not run)

Description

Lists bundles for a content item

Usage

get_bundles(content)

delete_bundle(content, bundle_id)

Arguments

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Get information about content on the Posit Connect server

Usage

get_content(src, guid = NULL, owner_guid = NULL, name = NULL, ..., .p = NULL)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/content for more information.

Value

A tibble with the following columns:

• guid: The unique identifier of this content item.

• name: A simple, URL-friendly identifier. Allows alpha-numeric characters, hyphens ("-"), and underscores ("_").

• title: The title of this content.

• description: A rich description of this content

• access_type: Access type describes how this content manages its viewers. It may have a value of all, logged_in or acl. The value all is the most permissive; any visitor to Posit Connect will be able to view this content. The value logged_in indicates that all Posit Connect accounts may view the content. The acl value lets specifically enumerated users and groups view the content. Users configured as collaborators may always view content.

• connection_timeout: Maximum number of seconds allowed without data sent or received across a client connection. A value of 0 means connections will never time-out (not recommended). When null, the default Scheduler.ConnectionTimeout is used. Applies only to content types that are executed on demand.

• read_timeout: Maximum number of seconds allowed without data received from a client connection. A value of 0 means a lack of client (browser) interaction never causes the connection to close. When null, the default Scheduler.ReadTimeout is used. Applies only to content types that are executed on demand.

• init_timeout: The maximum number of seconds allowed for an interactive application to start. Posit Connect must be able to connect to a newly launched Shiny application, for example, before this threshold has elapsed. When null, the default Scheduler.InitTimeout is used. Applies only to content types that are executed on demand.

• idle_timeout: The maximum number of seconds a worker process for an interactive application to remain alive after it goes idle (no active connections). When null, the default Scheduler.IdleTimeout is used. Applies only to content types that are executed on demand.

• max_processes: Specifies the total number of concurrent processes allowed for a single interactive application. When null, the default Scheduler.MaxProcesses setting is used. Applies only to content types that are executed on demand.

• min_processes: Specifies the minimum number of concurrent processes allowed for a single interactive application. When null, the default Scheduler.MinProcesses is used. Applies only to content types that are executed on demand.

• max_conns_per_process: Specifies the maximum number of client connections allowed to an individual process. Incoming connections which will exceed this limit are routed to a new process or rejected. When null, the default Scheduler.MaxConnsPerProcess is used. Applies only to content types that are executed on demand.

• load_factor: Controls how aggressively new processes are spawned. When null, the default Scheduler.LoadFactor is used. Applies only to content types that are executed on demand.

• created_time: The timestamp (RFC3339) indicating when this content was created.

• last_deployed_time: The timestamp (RFC3339) indicating when this content last had a successful bundle deployment performed.

• bundle_id: The identifier for the active deployment bundle. Automatically assigned upon the successful deployment of that bundle.

• app_mode: The runtime model for this content. Has a value of unknown before data is deployed to this item. Automatically assigned upon the first successful bundle deployment. Allowed: api, jupyter-static, python-api, python-bokeh, python-dash, python-streamlit, rmd-shiny, rmd-static, shiny, static, tensorflow-saved-model, unknown.

• content_category: Describes the specialization of the content runtime model. Automatically assigned upon the first successful bundle deployment.

• parameterized: True when R Markdown rendered content allows parameter configuration. Automatically assigned upon the first successful bundle deployment. Applies only to content with an app_mode of rmd-static.

• r_version: The version of the R interpreter associated with this content. The value null represents that an R interpreter is not used by this content or that the R package environment has not been successfully restored. Automatically assigned upon the successful deployment of a bundle.

• py_version: The version of the Python interpreter associated with this content. The value null represents that a Python interpreter is not used by this content or that the Python package environment has not been successfully restored. Automatically assigned upon the successful deployment of a bundle.

• run_as: The UNIX user that executes this content. When null, the default Applications.RunAs is used. Applies only to executable content types - not static.

• run_as_current_user: Indicates if this content is allowed to execute as the logged-in user when using PAM authentication. Applies only to executable content types - not static.

• owner_guid: The unique identifier for the owner

• content_url: The URL associated with this content. Computed from the associated vanity URL or GUID for this content.

• dashboard_url: The URL within the Connect dashboard where this content can be configured. Computed from the GUID for this content.

• role: The relationship of the accessing user to this content. A value of owner is returned for the content owner. editor indicates a collaborator. The viewer value is given to users who are permitted to view the content. A none role is returned for administrators who cannot view the content but are permitted to view its configuration. Computed at the time of the request.

• id: The internal numeric identifier of this content item

Examples

## Not run: 
library(connectapi)
client <- connect()

get_content(client)

## End(Not run)

Description

Manage Environment Variables for a piece of content.

Usage

get_environment(content)

set_environment_new(env, ...)

set_environment_remove(env, ...)

set_environment_all(env, ...)

Arguments

Details

get_environment() returns an Environment object for use with "setter" methods

set_environment_new() updates environment values (either creating new values or updating existing). Set NA as the value to remove a variable.

set_environment_remove() is a wrapper on set_environment_new() that allows removing named / listed variables quickly

set_environment_all() sets all environment variable values (will remove variables not specified)

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Get users within a specific group

Usage

get_group_members(src, guid)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/groups/-group_guid-/members for more information.

Value

A tibble with the following columns:

• email: The user's email

• username: The user's username

• first_name: The user's first name

• last_name: The user's last name

• user_role: The user's role. It may have a value of administrator, publisher or viewer.

• created_time: The timestamp (in RFC3339 format) when the user was created in the Posit Connect server

• updated_time: The timestamp (in RFC3339 format) when the user was last updated in the Posit Connect server

• active_time: The timestamp (in RFC3339 format) when the user was last active on the Posit Connect server

• confirmed: When false, the created user must confirm their account through an email. This feature is unique to password authentication.

• locked: Whether or not the user is locked

• guid: The user's GUID, or unique identifier, in UUID RFC4122 format

Examples

## Not run: 
library(connectapi)
client <- connect()

# get the first 20 groups
groups <- get_groups(client)

group_guid <- groups$guid[1]

get_group_members(client, guid = group_guid)

## End(Not run)

Description

Get group information from the Posit Connect server

Usage

get_groups(src, page_size = 500, prefix = NULL, limit = Inf)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/groups for more information.

Value

A tibble with the following columns:

• guid: The unique identifier of the group

• name: The group name

• owner_guid: The group owner's unique identifier. When using LDAP or Proxied authentication with group provisioning enabled this property will always be null.

Examples

## Not run: 
library(connectapi)
client <- connect()

# get all groups
get_groups(client, limit = Inf)

## End(Not run)

Description

Please use get_thumbnail, delete_thumbnail, and has_thumbnail instead.

get_image saves the content image to the given path (default: temp file). delete_image removes the image (optionally saving to the given path) has_image returns whether the content has an image

Usage

get_image(content, path = NULL)

delete_image(content, path = NULL)

has_image(content)

Arguments

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Retrieve details about jobs associated with a content_item. "Jobs" in Posit Connect are content executions

Usage

get_jobs(content)

get_job(content, key)

Arguments

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Perform an OAuth credential exchange to obtain a viewer's OAuth access token.

Usage

get_oauth_credentials(connect, user_session_token)

Arguments

Details

Please see https://docs.posit.co/connect/user/oauth-integrations/#obtaining-a-viewer-oauth-access-token for more information.

Value

The OAuth credential exchange response.

Examples

## Not run: 
library(connectapi)
library(plumber)
client <- connect()

#* @get /do
function(req) {
  user_session_token <- req$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN
  credentials <- get_oauth_credentials(client, user_session_token)

  # ... do something with `credentials$access_token` ...

  "done"
}

## End(Not run)

Description

This returns real-time process data from the Posit Connect API. It requires administrator privileges to use. NOTE that this only returns data for the server that responds to the request (i.e. in a Highly Available cluster)

Usage

get_procs(src)

Arguments

Value

A tibble with the following columns:

• pid: The PID of the current process

• appId: The application ID

• appGuid: The application GUID

• appName: The application name

• appUrl: The application URL

• appRunAs: The application RunAs user

• type: The type of process

• cpuCurrent: The current CPU usage

• cpuTotal: The total CPU usage

• ram: The current RAM usage

Description

View the runtime caches on a Connect server. Requires Administrator privileges.

Usage

get_runtime_caches(client)

Arguments

Value

A tibble of runtime caches on the server, showing language, version and image_name. For Connect servers not using off-host execution, image_name is "Local".

See Also

delete_runtime_cache()

Other server management functions: delete_runtime_cache()

Examples

## Not run: 
client <- connect()
get_runtime_caches(client)

## End(Not run)

Description

Get a table showing available versions of R, Python, Quarto, and Tensorflow on the Connect server.

Usage

get_runtimes(client, runtimes = NULL)

Arguments

Value

A tibble with columns for runtime, version, and cluster_name and image_name. Cluster name and image name are only meaningful on Connect instances running off-host execution.

Examples

## Not run: 
library(connectapi)
client <- connect()
get_runtimes(client, runtimes = c("r", "python", "tensorflow"))

## End(Not run)

Description

Tag manipulation and assignment functions

Usage

get_tags(src)

get_tag_data(src)

create_tag(src, name, parent = NULL)

create_tag_tree(src, ...)

delete_tag(src, tag)

get_content_tags(content)

set_content_tag_tree(content, ...)

set_content_tags(content, ...)

filter_tag_tree_id(tags, ids)

filter_tag_tree_chr(tags, pattern)

Arguments

Description

Download the thumbnail for a content item on Connect to a file on your computer.

Usage

get_thumbnail(content, path = NULL)

Arguments

Value

The path to the downloaded image file, if content has a thumbnail; otherwise NA.

See Also

Other thumbnail functions: delete_thumbnail(), has_thumbnail(), set_thumbnail()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Examples

## Not run: 
client <- connect()
item <- content_item(client, "8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0")
thumbnail <- get_thumbnail(item)

## End(Not run)

Description

Get the available timezones from the server.

Usage

get_timezones(connect)

Arguments

Value

A TimeZone vector to be used for setting time zones

See Also

Other schedule functions: get_variant_schedule(), set_schedule()

Description

Get usage information for deployed shiny applications

Usage

get_usage_shiny(
  src,
  content_guid = NULL,
  min_data_version = NULL,
  from = NULL,
  to = NULL,
  limit = 500,
  previous = NULL,
  nxt = NULL,
  asc_order = TRUE
)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/instrumentation/shiny/usage for more information.

Value

A tibble with the following columns:

• content_guid: The GUID, in RFC4122 format, of the Shiny application this information pertains to.

• user_guid: The GUID, in RFC4122 format, of the user that visited the application.

• started: The timestamp, in RFC3339 format, when the user opened the application.

• ended: The timestamp, in RFC3339 format, when the user left the application.

• data_version: The data version the record was recorded with. The Shiny Application Events section of the Posit Connect Admin Guide explains how to interpret data_version values.

Examples

## Not run: 
library(connectapi)
client <- connect()

from <- Sys.Date() - lubridate::days(5)
get_usage_shiny(client, limit = 20, from = from)

## End(Not run)

Description

This function retrieves usage information from static content on the Posit Connect server (e.g. Rmarkdown, Jupyter Notebooks)

Usage

get_usage_static(
  src,
  content_guid = NULL,
  min_data_version = NULL,
  from = NULL,
  to = NULL,
  limit = 500,
  previous = NULL,
  nxt = NULL,
  asc_order = TRUE
)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/instrumentation/content/visits for more information.

Value

A tibble with the following columns:

• content_guid: The GUID, in RFC4122 format, of the Shiny application this information pertains to.

• user_guid: The GUID, in RFC4122 format, of the user that visited the application.

• variant_key: The key of the variant the user visited. This will be null for static content.

• time: The timestamp, in RFC3339 format, when the user visited the content.

• rendering_id: The ID of the rendering the user visited. This will be null for static content.

• bundle_id: The ID of the particular bundle used.

• data_version: The data version the record was recorded with. The Rendered and Static Content Visit Events section of the Posit Connect Admin Guide explains how to interpret data_version values.

Examples

## Not run: 
library(connectapi)
client <- connect()

from <- Sys.Date() - lubridate::days(5)
get_usage_static(client, limit = 20, from = from)

## End(Not run)

Description

Get user information from the Posit Connect server

Usage

get_users(
  src,
  page_size = 500,
  prefix = NULL,
  limit = Inf,
  user_role = NULL,
  account_status = NULL
)

Arguments

Details

Please see https://docs.posit.co/connect/api/#get-/v1/users for more information.

Value

A tibble with the following columns:

• email: The user's email

• username: The user's username

• first_name: The user's first name

• last_name: The user's last name

• user_role: The user's role. It may have a value of administrator, publisher or viewer.

• created_time: The timestamp (in RFC3339 format) when the user was created in the Posit Connect server

• updated_time: The timestamp (in RFC3339 format) when the user was last updated in the Posit Connect server

• active_time: The timestamp (in RFC3339 format) when the user was last active on the Posit Connect server

• confirmed: When false, the created user must confirm their account through an email. This feature is unique to password authentication.

• locked: Whether or not the user is locked

• guid: The user's GUID, or unique identifier, in UUID RFC4122 format

Examples

## Not run: 
library(connectapi)
client <- connect()

# Get all users
get_users(client)

# Get all licensed users
get_users(client, account_status = "licensed")

# Get all users who are administrators or publishers
get_users(client, user_role = c("administrator", "publisher"))

## End(Not run)

Description

Gets the Vanity URL for a piece of content.

Usage

get_vanity_url(content)

Arguments

Value

A character string (or NULL if not defined)

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Get details about renderings (i.e. render history) or execute a variant on demand

Usage

get_variant_renderings(variant)

variant_render(variant)

Arguments

Details

• get_variant_renderings() returns all renderings / content for a particular variant. Returns a tibble

• variant_render() executes a variant on demand. Returns a VariantTask object

See Also

Other variant functions: get_variants()

Description

Gets the schedule associated with a Variant.

Usage

get_variant_schedule(variant)

Arguments

Value

A VariantSchedule object

See Also

Other schedule functions: get_timezones(), set_schedule()

Description

Work with variants

Usage

get_variants(content)

get_variant(content, key)

get_variant_default(content)

Arguments

Details

• get_variants() returns a tibble with variant data for a content_item

• get_variant_default() returns the default variant for a content_item

• get_variant() returns a specific variant for a content_item (specified by key)

See Also

Other variant functions: get_variant_renderings()

Other variant functions: get_variant_renderings()

Other variant functions: get_variant_renderings()

Description

These functions help use Posit Connect's configured authorization to query available branches and subdirectories for deployment using deploy_repo()

Usage

repo_check_account(client, host)

repo_check_branches(client, repository)

repo_check_branches_ref(client, repository)

repo_check_manifest_dirs(client, repository, branch)

Arguments

Details

• repo_check_account() messages whether an account is in use, and then returns that account

• repo_check_branches() retrieves which branches are available, returning in a named list

• repo_check_manifest_dirs() retrieves which directories contain a manifest.json, returning in a named list

See Also

connectapi::deploy_repo

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Create a Remote Group

Usage

groups_create_remote(connect, prefix, expect = 1, check = TRUE, exact = FALSE)

Arguments

Value

The results of creating the groups.

Description

Check whether a content item has a thumbnail.

Usage

has_thumbnail(content)

Arguments

Value

TRUE if the content item has a thumbnail, otherwise FALSE. Throws an error if you do not have permission to view the thumbnail.

See Also

Other thumbnail functions: delete_thumbnail(), get_thumbnail(), set_thumbnail()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, permissions, set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Examples

## Not run: 
client <- connect()
item <- content_item(client, "8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0")
has_thumbnail(item)

## End(Not run)

Description

Helper functions that make paging easier in the Posit Connect Server API.

Helper functions that make paging easier in the Posit Connect Server API.

Usage

page_cursor(client, req, limit = Inf)

page_offset(client, req, limit = Inf)

Arguments

Value

The aggregated results from all requests

The aggregated results from all requests

Description

Get or set content permissions for a content item

Usage

content_add_user(content, guid, role = c("viewer", "owner"))

content_add_group(content, guid, role = c("viewer", "owner"))

content_delete_user(content, guid)

content_delete_group(content, guid)

get_user_permission(content, guid, add_owner = TRUE)

get_my_permission(content, add_owner = TRUE)

get_group_permission(content, guid)

get_content_permissions(content, add_owner = TRUE)

Arguments

Details

Permission modification:

• ⁠content_add_*⁠ adds a permission to the content

• ⁠content_delete_*⁠ removes a permission from the content

Permission retrieval:

• get_content_permissions() lists permissions

• get_my_permission() gets the permission associated with the caller.

• get_user_permission() gets the permissions associated with a given user. It does not evaluate group memberships

• get_group_permission() gets the permissions associated with a given group.

NOTE: by default, the owner is injected with an "NA_character_" permission id. This makes it easier to find / isolate this record.

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), set_image_path(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Polls a task, waiting for information about a deployment. If the task has results, the output will be a modified "Task" object with task$get_data() available to retrieve the results.

Usage

poll_task(task, wait = 1, callback = message)

Arguments

Details

For a simple way to silence messages, set callback = NULL

Value

Task The Task object that was input

See Also

Other deployment functions: bundle_dir(), bundle_path(), bundle_static(), deploy(), download_bundle()

Description

Class representing a Connect API client

Class representing a Connect API client

Usage

client <- Connect$new(server = 'connect.example.com',
  apiKey = 'mysecretkey')
client$get_apps()
client$get_tags()

Details

This class allows a user to interact with a Connect server via the Connect API. Authentication is done by providing an API key.

Public fields

Active bindings

Methods

Public methods

• Connect$get_connect()

• Connect$new()

• Connect$httr_config()

• Connect$print()

• Connect$raise_error()

• Connect$add_auth()

• Connect$api_url()

• Connect$server_url()

• Connect$request()

• Connect$GET()

• Connect$PUT()

• Connect$HEAD()

• Connect$DELETE()

• Connect$PATCH()

• Connect$POST()

• Connect$me()

• Connect$get_dashboard_url()

• Connect$get_tags()

• Connect$get_tag_id()

• Connect$get_tag_tree()

• Connect$tag_create_safe()

• Connect$tag_create()

• Connect$tag()

• Connect$tag_delete()

• Connect$get_apps()

• Connect$get_schedule()

• Connect$content_create()

• Connect$content_upload()

• Connect$content_deploy()

• Connect$content()

• Connect$task()

• Connect$set_content_tag()

• Connect$remove_content_tag()

• Connect$user()

• Connect$users()

• Connect$users_remote()

• Connect$users_create()

• Connect$users_create_remote()

• Connect$users_lock()

• Connect$users_unlock()

• Connect$users_update()

• Connect$groups()

• Connect$group_members()

• Connect$group_member_add()

• Connect$group_member_remove()

• Connect$groups_create()

• Connect$groups_create_remote()

• Connect$groups_remote()

• Connect$inst_content_visits()

• Connect$inst_shiny_usage()

• Connect$procs()

• Connect$repo_account()

• Connect$repo_branches()

• Connect$repo_manifest_dirs()

• Connect$schedules()

• Connect$docs()

• Connect$audit_logs()

• Connect$server_settings_r()

• Connect$server_settings()

• Connect$clone()

Method get_connect()

Return this connect.

Usage

Connect$get_connect()

Method new()

Initialize a new connect.

Usage

Connect$new(server, api_key)

Arguments

Method httr_config()

Set additional httr configuration that is added to each HTTP call.

Usage

Connect$httr_config(...)

Arguments

Method print()

Print details about this instance.

Usage

Connect$print(...)

Arguments

Method raise_error()

Raise an error when the HTTP result is an HTTP error.

Usage

Connect$raise_error(res)

Arguments

Method add_auth()

Returns HTTP authorization headers, or NULL when none are used.

Usage

Connect$add_auth()

Method api_url()

Build a URL relative to the API root

Usage

Connect$api_url(...)

Arguments

Method server_url()

Build a URL relative to the server root

Usage

Connect$server_url(...)

Arguments

Method request()

General wrapper around httr verbs

Usage

Connect$request(method, url, ..., parser = "parsed")

Arguments

Method GET()

Perform an HTTP GET request of the named API path.

Usage

Connect$GET(path, ..., url = self$api_url(path), parser = "parsed")

Arguments

Method PUT()

Perform an HTTP PUT request of the named API path.

Usage

Connect$PUT(
  path,
  body = "{}",
  ...,
  url = self$api_url(path),
  encode = "json",
  parser = "parsed"
)

Arguments

Method HEAD()

Perform an HTTP HEAD request of the named API path.

Usage

Connect$HEAD(path, ..., url = self$api_url(path))

Arguments

Method DELETE()

Perform an HTTP DELETE request of the named API path. Returns the HTTP response object.

Usage

Connect$DELETE(path, ..., url = self$api_url(path), parser = NULL)

Arguments

Method PATCH()

Perform an HTTP PATCH request of the named API path.

Usage

Connect$PATCH(
  path,
  body = "{}",
  ...,
  url = self$api_url(path),
  encode = "json",
  parser = "parsed"
)

Arguments

Method POST()

Perform an HTTP POST request of the named API path.

Usage

Connect$POST(
  path,
  body = "{}",
  ...,
  url = self$api_url(path),
  encode = "json",
  parser = "parsed"
)

Arguments

Method me()

Perform an HTTP GET request of the "me" server endpoint.

Usage

Connect$me()

Method get_dashboard_url()

Return the base URL of the Connect server.

Usage

Connect$get_dashboard_url()

Method get_tags()

Return all tags.

Usage

Connect$get_tags(use_cache = FALSE)

Arguments

Method get_tag_id()

Get the identifier for the named tag.

Usage

Connect$get_tag_id(tagname)

Arguments

Method get_tag_tree()

Get the tag tree.

Usage

Connect$get_tag_tree()

Method tag_create_safe()

Create a tag.

Usage

Connect$tag_create_safe(name, parent_id = NULL)

Arguments

Method tag_create()

Create a tag.

Usage

Connect$tag_create(name, parent_id = NULL)

Arguments

Method tag()

Get a tag.

Usage

Connect$tag(id = NULL)

Arguments

Method tag_delete()

Delete a tag.

Usage

Connect$tag_delete(id)

Arguments

Method get_apps()

Get content items.

Usage

Connect$get_apps(filter = NULL, .collapse = "&", .limit = Inf, page_size = 25)

Arguments

Method get_schedule()

Get a schedule.

Usage

Connect$get_schedule(schedule_id)

Arguments

Method content_create()

Create content.

Usage

Connect$content_create(name, title = name, ...)

Arguments

Method content_upload()

Upload a content bundle.

Usage

Connect$content_upload(bundle_path, guid)

Arguments

Method content_deploy()

Deploy a content bundle.

Usage

Connect$content_deploy(guid, bundle_id)

Arguments

Method content()

Get a content item.

Usage

Connect$content(
  guid = NULL,
  owner_guid = NULL,
  name = NULL,
  include = "tags,owner"
)

Arguments

Method task()

Get a task.

Usage

Connect$task(task_id, first = 0, wait = 5)

Arguments

Method set_content_tag()

Set a tag for a content item.

Usage

Connect$set_content_tag(content_id, tag_id)

Arguments

Method remove_content_tag()

Remove a tag from a content item.

Usage

Connect$remove_content_tag(content_id, tag_id)

Arguments

Method user()

Get user details.

Usage

Connect$user(guid)

Arguments

Method users()

Get users.

Usage

Connect$users(
  page_number = 1,
  prefix = NULL,
  page_size = 500,
  user_role = NULL,
  account_status = NULL
)

Arguments

Method users_remote()

Get remote users.

Usage

Connect$users_remote(prefix)

Arguments

Method users_create()

Create a user.

Usage

Connect$users_create(
  username,
  email,
  first_name = NULL,
  last_name = NULL,
  password = NULL,
  user_must_set_password = NULL,
  user_role = NULL,
  unique_id = NULL
)

Arguments

Method users_create_remote()

Create a remote user.

Usage

Connect$users_create_remote(temp_ticket)

Arguments

Method users_lock()

Lock a user.

Usage

Connect$users_lock(user_guid)

Arguments

Method users_unlock()

Unlock a user.

Usage

Connect$users_unlock(user_guid)

Arguments

Method users_update()

Update a user.

Usage

Connect$users_update(user_guid, ...)

Arguments

Method groups()

Get groups.

Usage

Connect$groups(page_number = 1, prefix = NULL, page_size = 500)

Arguments

Method group_members()

Get group members.

Usage

Connect$group_members(guid)

Arguments

Method group_member_add()

Add a group member.

Usage

Connect$group_member_add(group_guid, user_guid)

Arguments

Method group_member_remove()

Remove a group member.

Usage

Connect$group_member_remove(group_guid, user_guid)

Arguments

Method groups_create()

Create a group.

Usage

Connect$groups_create(name)

Arguments

Method groups_create_remote()

Create a remote group.

Usage

Connect$groups_create_remote(temp_ticket)

Arguments

Method groups_remote()

Get remote groups.

Usage

Connect$groups_remote(prefix = NULL, limit = 500)

Arguments

Method inst_content_visits()

Get (non-interactive) content visits.

Usage

Connect$inst_content_visits(
  content_guid = NULL,
  min_data_version = NULL,
  from = NULL,
  to = NULL,
  limit = 500,
  previous = NULL,
  nxt = NULL,
  asc_order = TRUE
)

Arguments

Method inst_shiny_usage()

Get interactive content visits.

Get (non-interactive) content visits.

Usage

Connect$inst_shiny_usage(
  content_guid = NULL,
  min_data_version = NULL,
  from = NULL,
  to = NULL,
  limit = 500,
  previous = NULL,
  nxt = NULL,
  asc_order = TRUE
)

Arguments

Method procs()

Get running processes.

Usage

Connect$procs()

Method repo_account()

Determine if Git repository is associated with authorization.

Usage

Connect$repo_account(host)

Arguments

Method repo_branches()

Get Git repository branches.

Usage

Connect$repo_branches(repo)

Arguments

Method repo_manifest_dirs()

Get Git repository directories.

Usage

Connect$repo_manifest_dirs(repo, branch)

Arguments

Method schedules()

Get schedules.

Usage

Connect$schedules(
  start = Sys.time(),
  end = Sys.time() + 60 * 60 * 24 * 7,
  detailed = FALSE
)

Arguments

Method docs()

Get documentation.

Usage

Connect$docs(docs = "api", browse = TRUE)

Arguments

Method audit_logs()

Get auditing.

Usage

Connect$audit_logs(limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE)

Arguments

Method server_settings_r()

Get R installations.

Usage

Connect$server_settings_r()

Method server_settings()

Get server settings.

Usage

Connect$server_settings()

Method clone()

The objects of this class are cloneable with this method.

Usage

Connect$clone(deep = FALSE)

Arguments

See Also

Other R6 classes: Bundle, Content, ContentTask, Environment, Task, Vanity, Variant, VariantSchedule, VariantTask

Description

Promote content from one Connect server to another

Usage

promote(from, to, to_key, from_key, name)

Arguments

Value

The URL for the content on the destination "to" server

Description

Please use set_thumbnail instead.

Set the Content Image using a variety of methods.

Usage

set_image_path(content, path)

set_image_url(content, url)

set_image_webshot(content, ...)

Arguments

Details

NOTE: set_image_webshot() requires webshot2::webshot(), but currently skips and warns for any content that requires authentication until the webshot2 package supports authentication.

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Set the RunAs user for a piece of content. The run_as_current_user flag only does anything if:

Usage

set_run_as(content, run_as, run_as_current_user = FALSE)

Arguments

Details

• PAM is the authentication method

• Applications.RunAsCurrentUser is enabled on the server

Also worth noting that the run_as user must exist on the Posit Connect server (as a linux user) and have appropriate group memberships, or you will get a ⁠400: Bad Request⁠. Set to NULL to use the default RunAs user / unset any current configuration.

To "read" the current RunAs user, use the Content object or get_content() function.

Value

a Content object, updated with new details

See Also

connectapi::content_update

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Description

Sets the schedule for a given Variant. Requires a Schedule object (as returned by get_variant_schedule())

Usage

set_schedule(.schedule, ...)

set_schedule_minute(
  .schedule,
  n = 30,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_hour(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_day(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_weekday(
  .schedule,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_week(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_dayofweek(
  .schedule,
  days,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_semimonth(
  .schedule,
  first = TRUE,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_dayofmonth(
  .schedule,
  n = 1,
  day = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_dayweekofmonth(
  .schedule,
  n = 1,
  day = 1,
  week = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_year(
  .schedule,
  n = 1,
  start_time = Sys.time(),
  activate = TRUE,
  email = FALSE,
  timezone = Sys.timezone()
)

set_schedule_remove(.schedule)

schedule_describe(.schedule)

Arguments

Details

• set_schedule() is a raw interface to Posit Connect's schedule API

• ⁠set_schedule_*()⁠ functions provide handy wrappers around set_schedule()

• set_schedule_remove() removes a schedule / un-schedules a variant

Beware, using set_schedule() currently uses the Posit Connect schedule API directly, and so can be a little clunky. Using the ⁠set_schedule_*()⁠ is generally recommended.

Value

An updated Schedule object

See Also

Other schedule functions: get_timezones(), get_variant_schedule()

Description

Set the thumbnail for a content item.

Usage

set_thumbnail(content, path)

Arguments

Value

The content item (invisibly).

See Also

Other thumbnail functions: delete_thumbnail(), get_thumbnail(), has_thumbnail()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_vanity_url(), swap_vanity_url(), verify_content_name()

Examples

## Not run: 
client <- connect()
item <- content_item(client, "8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0")
set_thumbnail(item, "resources/image.png")

## End(Not run)

Description

Sets the Vanity URL for a piece of content.

Usage

set_vanity_url(content, url, force = FALSE)

Arguments

Value

An updated Content object

See Also

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), dashboard_url_chr(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_bundles(), get_environment(), get_image(), get_jobs(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), permissions, set_image_path(), set_run_as(), set_thumbnail(), swap_vanity_url(), verify_content_name()