Package: connectapi 0.6.0.9000

Toph Allen

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

Provides a helpful 'R6' class and methods for interacting with the 'Posit Connect' Server API along with some meaningful utility functions for regular tasks. API documentation varies by 'Posit Connect' installation and version, but the latest documentation is also hosted publicly at <https://docs.posit.co/connect/api/>.

Authors:Toph Allen [aut, cre], Neal Richardson [aut], Sean Lopp [aut], Cole Arendt [aut], Posit, PBC [cph, fnd]

connectapi_0.6.0.9000.tar.gz
connectapi_0.6.0.9000.zip(r-4.5)connectapi_0.6.0.9000.zip(r-4.4)connectapi_0.6.0.9000.zip(r-4.3)
connectapi_0.6.0.9000.tgz(r-4.5-any)connectapi_0.6.0.9000.tgz(r-4.4-any)connectapi_0.6.0.9000.tgz(r-4.3-any)
connectapi_0.6.0.9000.tar.gz(r-4.5-noble)connectapi_0.6.0.9000.tar.gz(r-4.4-noble)
connectapi_0.6.0.9000.tgz(r-4.4-emscripten)connectapi_0.6.0.9000.tgz(r-4.3-emscripten)
connectapi.pdf |connectapi.html✨
connectapi/json (API)
NEWS

# Install 'connectapi' in R:
install.packages('connectapi', repos = c('https://posit-dev.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/posit-dev/connectapi/issues

Pkgdown site:https://posit-dev.github.io

On CRAN:

Conda:

api-clientrstudio-connect

10.42 score 47 stars 1 packages 252 scripts 1.3k downloads 139 exports 25 dependencies

Last updated 5 days agofrom:79bd3c987a. Checks:9 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKMar 25 2025
R-4.5-winOKMar 25 2025
R-4.5-macOKMar 25 2025
R-4.5-linuxOKMar 25 2025
R-4.4-winOKMar 25 2025
R-4.4-macOKMar 25 2025
R-4.4-linuxOKMar 25 2025
R-4.3-winOKMar 25 2025
R-4.3-macOKMar 25 2025

Exports:%>%audit_access_openaudit_r_versionsaudit_runasbrowse_api_docsbrowse_connectbrowse_dashboardbrowse_soloBundlebundle_dirbundle_pathbundle_staticconnectConnectContentcontent_add_groupcontent_add_usercontent_deletecontent_delete_groupcontent_delete_usercontent_itemcontent_list_by_tagcontent_list_guid_has_accesscontent_list_with_permissionscontent_rendercontent_restartcontent_titlecontent_updatecontent_update_access_typecontent_update_ownerContentTaskcreate_random_namecreate_tagcreate_tag_treedashboard_urldashboard_url_chrdelete_bundledelete_imagedelete_runtime_cachedelete_tagdelete_thumbnaildelete_vanity_urldeploydeploy_currentdeploy_repodeploy_repo_enabledeploy_repo_updatedownload_bundleEnvironmentfilter_tag_tree_chrfilter_tag_tree_idget_audit_logsget_aws_content_credentialsget_aws_credentialsget_bundlesget_contentget_content_packagesget_content_permissionsget_content_tagsget_environmentget_group_contentget_group_membersget_group_permissionget_groupsget_imageget_jobget_job_listget_jobsget_logget_my_permissionget_oauth_content_credentialsget_oauth_credentialsget_packagesget_procsget_runtime_cachesget_runtimesget_tag_dataget_tagsget_thumbnailget_timezonesget_usage_shinyget_usage_staticget_user_permissionget_usersget_vanity_urlget_vanity_urlsget_variantget_variant_defaultget_variant_renderingsget_variant_scheduleget_variantsgroups_create_remotehas_imagehas_thumbnailpage_cursorpage_offsetpoll_taskpromoterepo_check_accountrepo_check_branchesrepo_check_branches_refrepo_check_manifest_dirsschedule_describeset_content_tag_treeset_content_tagsset_environment_allset_environment_newset_environment_removeset_image_pathset_image_urlset_image_webshotset_run_asset_scheduleset_schedule_dayset_schedule_dayofmonthset_schedule_dayofweekset_schedule_dayweekofmonthset_schedule_hourset_schedule_minuteset_schedule_removeset_schedule_semimonthset_schedule_weekset_schedule_weekdayset_schedule_yearset_thumbnailset_vanity_urlswap_vanity_urlswap_vanity_urlsTasktbl_connectterminate_jobsuser_guid_from_usernameusers_create_remoteVanityvanity_is_availableVariantvariant_renderVariantScheduleverify_content_name

Dependencies:askpassbase64encbitbit64clicurlfansifsgluehttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigpurrrR6rlangsystibbleutf8uuidvctrs

Customize HTTP Requests

Cole Arendt

Rendered fromcustomize-http.Rmdusingknitr::rmarkdownon Mar 25 2025.

Last update: 2024-09-09
Started: 2021-05-14

Getting Started with connectapi

Cole Arendt

Rendered fromgetting-started.Rmdusingknitr::rmarkdownon Mar 25 2025.

Last update: 2024-10-08
Started: 2019-04-30

Readme and manuals

Help Manual

Help pageTopics
Audit Access Controlsaudit_access_open
Audit R Versionsaudit_r_versions
Audit Run As Settingsaudit_runas
Browsebrowse_api_docs browse_connect browse_dashboard browse_solo
BundleBundle
Define a bundle from a Directorybundle_dir
Define a bundle from a path (a path directly to a tar.gz file)bundle_path
Define a bundle from a static file (or files)bundle_static
Create a connection to Posit Connectconnect
ContentContent
Delete Contentcontent_delete
Get Content Itemcontent_item
Content Listcontent_list_by_tag
Get Content List with Permissionscontent_list_guid_has_access content_list_with_permissions
Render a content item.content_render
Restart a content item.content_restart
Get Content Titlecontent_title
Update Contentcontent_update content_update_access_type content_update_owner
ContentTaskContentTask
Create Random Namecreate_random_name
Build a Dashboard URL from a Content Itemdashboard_url
Build a Dashboard URL from Character Vectorsdashboard_url_chr
Delete a runtime cachedelete_runtime_cache
Delete content item thumbnaildelete_thumbnail
Delete the Vanity URLdelete_vanity_url
Deploy a bundledeploy deploy_current
Deploy a Git Repositorydeploy_repo deploy_repo_enable deploy_repo_update
Download a Bundle from Deployed Connect Contentdownload_bundle
EnvironmentEnvironment
Get Audit Logs from Posit Connect Serverget_audit_logs
Obtain AWS credentials for your content.get_aws_content_credentials
Obtain a visitor's AWS credentialsget_aws_credentials
Get Bundlesdelete_bundle get_bundles
Get information about content on the Posit Connect serverget_content
Package dependencies for a content itemget_content_packages
Manage Environment Variablesget_environment set_environment_all set_environment_new set_environment_remove
Get content access permissions for a group or groupsget_group_content
Get users within a specific groupget_group_members
Get group information from the Posit Connect serverget_groups
Get the Content Imagedelete_image get_image has_image
Retrieve details about a server process associated with a 'content_item', such as a FastAPI app or a Quarto render.get_job
Get Jobsget_jobs get_job_list
Get Job Logget_log
Perform an OAuth credential exchange to obtain a content-specific OAuth access token.get_oauth_content_credentials
Perform an OAuth credential exchange to obtain a visitor's OAuth access token.get_oauth_credentials
All package dependencies on the serverget_packages
Get Real-Time Process Dataget_procs
Get runtime cachesget_runtime_caches
Get available runtimes on serverget_runtimes
Get all Tags on the servercreate_tag create_tag_tree delete_tag filter_tag_tree_chr filter_tag_tree_id get_content_tags get_tags get_tag_data set_content_tags set_content_tag_tree
Get content item thumbnailget_thumbnail
Get TimeZonesget_timezones
Get usage information for deployed shiny applicationsget_usage_shiny
Get usage information from deployed static contentget_usage_static
Get user information from the Posit Connect serverget_users
Get the Vanity URLget_vanity_url
Get all vanity URLsget_vanity_urls
Render a Variantget_variant_renderings variant_render
Get a Variant Scheduleget_variant_schedule
Get Variantget_variant get_variants get_variant_default
Git Repository Helpersgit repo_check_account repo_check_branches repo_check_branches_ref repo_check_manifest_dirs
Create a Remote Groupgroups_create_remote
Check content item thumbnailhas_thumbnail
Pagingpage_cursor page_offset
Content permissionscontent_add_group content_add_user content_delete_group content_delete_user get_content_permissions get_group_permission get_my_permission get_user_permission permissions
Poll Taskpoll_task
Class representing a Connect API clientConnect PositConnect
Promote content from one Connect server to anotherpromote
Set the Content Imageset_image_path set_image_url set_image_webshot
Set RunAs Userset_run_as
Set a Scheduleschedule_describe set_schedule set_schedule_day set_schedule_dayofmonth set_schedule_dayofweek set_schedule_dayweekofmonth set_schedule_hour set_schedule_minute set_schedule_remove set_schedule_semimonth set_schedule_week set_schedule_weekday set_schedule_year
Set content item thumbnailset_thumbnail
Set the Vanity URLset_vanity_url
Swap Vanity URLsswap_vanity_url
Swap Vanity URLsswap_vanity_urls
TaskTask
Connect Tibbletbl_connect
Terminate Jobsterminate_jobs
Useruser_guid_from_username
Create a Remote Userusers_create_remote
VanityVanity
Check to see if a vanity URL is currently in usevanity_is_available
VariantVariant
VariantScheduleVariantSchedule
VariantTaskVariantTask
Verify Content Nameverify_content_name