Utilities for Interacting with the 'Posit Connect' Server API

Documentation for package ‘connectapi’ version 0.7.0

Help Pages

-- A --

audit_access_open	Audit Access Controls
audit_runas	Audit Run As Settings
audit_r_versions	Audit R Versions

-- B --

browse_api_docs	Browse
browse_connect	Browse
browse_dashboard	Browse
browse_solo	Browse
Bundle	Bundle
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)

-- C --

Connect	Class representing a Connect API client
connect	Create a connection to Posit Connect
Content	Content
ContentTask	ContentTask
content_add_group	Content permissions
content_add_user	Content permissions
content_delete	Delete Content
content_delete_group	Content permissions
content_delete_user	Content permissions
content_item	Get Content Item
content_list_by_tag	Content List
content_list_guid_has_access	Get Content List with Permissions
content_list_with_permissions	Get Content List with Permissions
content_render	Render a content item.
content_restart	Restart a content item.
content_title	Get Content Title
content_update	Update Content
content_update_access_type	Update Content
content_update_owner	Update Content
create_random_name	Create Random Name
create_tag	Get all Tags on the server
create_tag_tree	Get all Tags on the server

-- D --

dashboard_url	Build a Dashboard URL from a Content Item
dashboard_url_chr	Build a Dashboard URL from Character Vectors
delete_bundle	Get Bundles
delete_image	Get the Content Image
delete_runtime_cache	Delete a runtime cache
delete_tag	Get all Tags on the server
delete_thumbnail	Delete content item thumbnail
delete_vanity_url	Delete the Vanity URL
deploy	Deploy a bundle
deploy_current	Deploy a bundle
deploy_repo	Deploy a Git Repository
deploy_repo_enable	Deploy a Git Repository
deploy_repo_update	Deploy a Git Repository
download_bundle	Download a Bundle from Deployed Connect Content

-- E --

Environment

-- F --

filter_tag_tree_chr	Get all Tags on the server
filter_tag_tree_id	Get all Tags on the server

-- G --

get_audit_logs	Get Audit Logs from Posit Connect Server
get_aws_content_credentials	Obtain AWS credentials for your content.
get_aws_credentials	Obtain a visitor's AWS credentials
get_bundles	Get Bundles
get_content	Get information about content on the Posit Connect server
get_content_packages	Package dependencies for a content item
get_content_permissions	Content permissions
get_content_tags	Get all Tags on the server
get_environment	Manage Environment Variables
get_groups	Get group information from 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_group_permission	Content permissions
get_image	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_job_list	Get Jobs
get_log	Get Job Log
get_my_permission	Content permissions
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 visitor's OAuth access token.
get_packages	All package dependencies on the server
get_procs	Get Real-Time Process Data
get_runtimes	Get available runtimes on server
get_runtime_caches	Get runtime caches
get_tags	Get all Tags on the server
get_tag_data	Get all Tags on the 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_user_permission	Content permissions
get_vanity_url	Get the Vanity URL
get_vanity_urls	Get all vanity URLs
get_variant	Get Variant
get_variants	Get Variant
get_variant_default	Get Variant
get_variant_renderings	Render a Variant
get_variant_schedule	Get a Variant Schedule
git	Git Repository Helpers
groups_create_remote	Create a Remote Group

-- H --

has_image	Get the Content Image
has_thumbnail	Check content item thumbnail

-- P --

page_cursor	Paging
page_offset	Paging
permissions	Content permissions
poll_task	Poll Task
PositConnect	Class representing a Connect API client
promote	Promote content from one Connect server to another

-- R --

repo_check_account	Git Repository Helpers
repo_check_branches	Git Repository Helpers
repo_check_branches_ref	Git Repository Helpers
repo_check_manifest_dirs	Git Repository Helpers

-- S --

schedule_describe	Set a Schedule
set_content_tags	Get all Tags on the server
set_content_tag_tree	Get all Tags on the server
set_environment_all	Manage Environment Variables
set_environment_new	Manage Environment Variables
set_environment_remove	Manage Environment Variables
set_image_path	Set the Content Image
set_image_url	Set the Content Image
set_image_webshot	Set the Content Image
set_run_as	Set RunAs User
set_schedule	Set a Schedule
set_schedule_day	Set a Schedule
set_schedule_dayofmonth	Set a Schedule
set_schedule_dayofweek	Set a Schedule
set_schedule_dayweekofmonth	Set a Schedule
set_schedule_hour	Set a Schedule
set_schedule_minute	Set a Schedule
set_schedule_remove	Set a Schedule
set_schedule_semimonth	Set a Schedule
set_schedule_week	Set a Schedule
set_schedule_weekday	Set a Schedule
set_schedule_year	Set a Schedule
set_thumbnail	Set content item thumbnail
set_vanity_url	Set the Vanity URL
swap_vanity_url	Swap Vanity URLs
swap_vanity_urls	Swap Vanity URLs

-- T --

Task	Task
tbl_connect	Connect Tibble
terminate_jobs	Terminate Jobs

-- U --

users_create_remote	Create a Remote User
user_guid_from_username	User

-- V --

Vanity	Vanity
vanity_is_available	Check to see if a vanity URL is currently in use
Variant	Variant
VariantSchedule	VariantSchedule
VariantTask	VariantTask
variant_render	Render a Variant
verify_content_name	Verify Content Name