Package index • connectapi

Package

Package documentation

connectapi-package: connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Audit

Functions to audit vanity URLs, R versions, etc.

audit_access_open() experimental: Audit Access Controls

audit_r_versions() experimental: Audit R Versions

audit_runas() experimental: Audit Run As Settings

get_audit_logs(): Get Audit Logs from Posit Connect Server

Deployment

Functions to work with deployments

bundle_dir(): Define a bundle from a Directory

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

bundle_static(): Define a bundle from a static file (or files)

Bundle: Bundle

download_bundle(): Download a Bundle from Deployed Connect Content

deploy() deploy_current(): Deploy a bundle

poll_task(): Poll Task

Content

Functions to work with content

content_delete(): Delete Content

content_item(): Get Content Item

content_list_by_tag() experimental: Content List

content_list_with_permissions() content_list_guid_has_access() experimental: Get Content List with Permissions

content_render(): Render a content item.

content_restart(): Restart a content item.

content_title(): Get Content Title

content_update() content_update_access_type() content_update_owner(): Update Content

get_content(): Get information about content on the Posit Connect server

get_group_content(): Get content access permissions for a group or groups

get_oauth_content_credentials(): Perform an OAuth credential exchange to obtain a content-specific OAuth access token.

content_add_user() content_add_group() content_delete_user() content_delete_group() get_user_permission() get_my_permission() get_group_permission() get_content_permissions(): Content permissions

get_tags() get_tag_data() create_tag() create_tag_tree() delete_tag() get_content_tags() set_content_tag_tree() set_content_tags() filter_tag_tree_id() filter_tag_tree_chr(): Get all Tags on the server

verify_content_name(): Verify Content Name

get_variant_schedule() experimental: Get a Variant Schedule

get_variants() get_variant() get_variant_default() experimental: Get Variant

get_variant_renderings() variant_render() experimental: Render a Variant

delete_thumbnail(): Delete content item thumbnail

get_thumbnail(): Get content item thumbnail

has_thumbnail(): Check content item thumbnail

set_thumbnail(): Set content item thumbnail

get_image() delete_image() has_image() deprecated: Get the Content Image

set_image_path() set_image_url() set_image_webshot() deprecated: Set the Content Image

delete_vanity_url(): Delete the Vanity URL

get_vanity_url(): Get the Vanity URL

get_vanity_urls(): Get all vanity URLs

set_vanity_url(): Set the Vanity URL

swap_vanity_url(): Swap the Vanity URL

vanity_is_available() experimental: Check to see if a vanity URL is currently in use

set_schedule() set_schedule_minute() set_schedule_hour() set_schedule_day() set_schedule_weekday() set_schedule_week() set_schedule_dayofweek() set_schedule_semimonth() set_schedule_dayofmonth() set_schedule_dayweekofmonth() set_schedule_year() set_schedule_remove() schedule_describe() experimental: Set a Schedule

get_job(): Retrieve details about a server process associated with a content_item, such as a FastAPI app or a Quarto render.

get_jobs(): Get Jobs

terminate_jobs(): Terminate Jobs

set_run_as(): Set RunAs User

Users and groups

Users and groups

get_users(): Get user information from the Posit Connect server

content_add_user() content_add_group() content_delete_user() content_delete_group() get_user_permission() get_my_permission() get_group_permission() get_content_permissions(): Content permissions

user_guid_from_username(): User

users_create_remote(): Create a Remote User

get_group_content(): Get content access permissions for a group or groups

get_group_members(): Get users within a specific group

get_groups(): Get group information from the Posit Connect server

groups_create_remote(): Create a Remote Group

shiny

Shiny functions

get_usage_shiny(): Get usage information for deployed shiny applications

git

Git repository functions

deploy_repo() deploy_repo_enable() deploy_repo_update() experimental: Deploy a Git Repository

repo_check_account() repo_check_branches() repo_check_branches_ref() repo_check_manifest_dirs() experimental: Git Repository Helpers

Reporting

Helpers to “get” data out of Connect

get_environment() set_environment_new() set_environment_remove() set_environment_all(): Manage Environment Variables

get_audit_logs(): Get Audit Logs from Posit Connect Server

get_bundles() delete_bundle(): Get Bundles

get_content(): Get information about content on the Posit Connect server

get_group_content(): Get content access permissions for a group or groups

get_group_members(): Get users within a specific group

get_groups(): Get group information from the Posit Connect server

get_image() delete_image() has_image() deprecated: Get the Content Image

get_job(): Retrieve details about a server process associated with a content_item, such as a FastAPI app or a Quarto render.

get_jobs(): Get Jobs

get_oauth_content_credentials(): Perform an OAuth credential exchange to obtain a content-specific OAuth access token.

get_oauth_credentials(): Perform an OAuth credential exchange to obtain a viewer's OAuth access token.

get_procs() experimental: Get Real-Time Process Data

get_runtime_caches(): Get runtime caches

get_runtimes(): Get available runtimes on server

get_thumbnail(): Get content item thumbnail

get_timezones(): Get TimeZones

get_usage_shiny(): Get usage information for deployed shiny applications

get_usage_static(): Get usage information from deployed static content

get_users(): Get user information from the Posit Connect server

get_vanity_url(): Get the Vanity URL

get_vanity_urls(): Get all vanity URLs

get_variant_schedule() experimental: Get a Variant Schedule

content_add_user() content_add_group() content_delete_user() content_delete_group() get_user_permission() get_my_permission() get_group_permission() get_content_permissions(): Content permissions

get_tags() get_tag_data() create_tag() create_tag_tree() delete_tag() get_content_tags() set_content_tag_tree() set_content_tags() filter_tag_tree_id() filter_tag_tree_chr(): Get all Tags on the server

get_variants() get_variant() get_variant_default() experimental: Get Variant

get_variant_renderings() variant_render() experimental: Render a Variant

Other

Other functions

promote(): Promote content from one Connect server to another

connect(): Create a connection to Posit Connect

tbl_connect() experimental: Connect Tibble

page_cursor() page_offset(): Paging

browse_solo() browse_dashboard() browse_api_docs() browse_connect(): Browse

create_random_name(): Create Random Name

dashboard_url(): Build a Dashboard URL from a Content Item

dashboard_url_chr(): Build a Dashboard URL from Character Vectors

delete_runtime_cache(): Delete a runtime cache

R6 classes

Classes representing connect, users, etc.

PositConnect Connect: Class representing a Connect API client

Bundle: Bundle

Task: Task

ContentTask: ContentTask

Variant: Variant

VariantTask: VariantTask

VariantSchedule: VariantSchedule

Vanity: Vanity

Content: Content

Environment: Environment