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

Description

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/.

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/.

Author(s)

Maintainer: Toph Allen toph@posit.co

Authors:

• Neal Richardson

• Sean Lopp

• Cole Arendt

Other contributors:

• Posit, PBC [copyright holder, funder]

See Also

Useful links:

• https://posit-dev.github.io/connectapi/

• https://github.com/posit-dev/connectapi

• Report bugs at https://github.com/posit-dev/connectapi/issues

Useful links:

• https://posit-dev.github.io/connectapi/

• https://github.com/posit-dev/connectapi

• Report bugs at https://github.com/posit-dev/connectapi/issues

Pipe operator

Description

See ⁠magrittr::[\%>\%][magrittr::\%>\%]⁠ for details.

Usage

lhs %>% rhs

Bundle

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

Content

Description

Content

Content

Details

An R6 class that represents content.

Public fields

Active bindings

Methods

Public methods

• Content$new()

• Content$get_content_remote()

• Content$get_bundles()

• Content$bundle_download()

• Content$bundle_delete()

• Content$update()

• Content$danger_delete()

• Content$get_url()

• Content$get_dashboard_url()

• Content$jobs()

• Content$job()

• Content$register_job_kill_order()

• 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$repository()

• Content$repo_enable()

• Content$repo_set()

• Content$packages()

• Content$print()

• Content$clone()

Method new()

Initialize this content.

Usage

Content$new(connect, content)

Arguments

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 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 register_job_kill_order()

Terminate a single job for this content item.

Usage

Content$register_job_kill_order(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 repository()

Get Git repository details

Usage

Content$repository()

Returns

NULL if no repo is set, otherwise a list with fields:

• repository

• branch

• directory

• polling

• last_error

• last_known_commit

Method repo_enable()

Adjust Git polling.

Usage

Content$repo_enable(polling = TRUE)

Arguments

Method repo_set()

Adjust Git repository

Usage

Content$repo_set(repository, branch = "main", directory = ".", polling = FALSE)

Arguments

Method packages()

Get package dependencies

Usage

Content$packages()

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

ContentTask

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

Environment

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

Class representing a Connect API client

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$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_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$group_content()

• Connect$inst_content_visits()

• Connect$inst_shiny_usage()

• Connect$procs()

• Connect$repo_account()

• Connect$repo_branches()

• Connect$repo_manifest_dirs()

• Connect$schedules()

• Connect$packages()

• Connect$docs()

• Connect$audit_logs()

• Connect$vanities()

• Connect$server_settings_r()

• Connect$server_settings()

• Connect$clone()

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_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 group_content()

Get content to which a group has access

Usage

Connect$group_content(guid)

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 packages()

Get packages. This endpoint is paginated.

Usage

Connect$packages(name = NULL, page_number = 1, page_size = 1e+05)

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 vanities()

Get all vanity URLs

Usage

Connect$vanities()

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

Task

Description

Task

Task

Details

An R6 class that represents a Task

Public fields

Methods

Public methods

• Task$new()

• Task$get_task()

• Task$add_data()

• Task$get_data()

• Task$print()

• Task$clone()

Method new()

Initialize this task.

Usage

Task$new(connect, task)

Arguments

Method get_task()

Return the underlying task.

Usage

Task$get_task()

Method add_data()

Set the data.

Usage

Task$add_data(data)

Arguments

Method get_data()

Get the data.

Usage

Task$get_data()

Method print()

Print this object.

Usage

Task$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Task$clone(deep = FALSE)

Arguments

See Also

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

Vanity

Description

Vanity

Vanity

Details

An R6 class that represents a Vanity URL

Super class

connectapi::Content -> Vanity

Public fields

Methods

Public methods

• Vanity$new()

• Vanity$get_vanity()

• Vanity$print()

• Vanity$clone()

Method new()

Initialize this vanity.

Usage

Vanity$new(connect, content, vanity)

Arguments

Method get_vanity()

Return the underlying vanity.

Usage

Vanity$get_vanity()

Method print()

Print this object.

Usage

Vanity$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Vanity$clone(deep = FALSE)

Arguments

See Also

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

Variant

Description

Variant

Variant

Details

An R6 class that represents a Variant

Super class

connectapi::Content -> Variant

Public fields

Methods

Public methods

• Variant$get_variant_remote()

• Variant$new()

• Variant$send_mail()

• Variant$get_schedule()

• Variant$get_schedule_remote()

• Variant$get_subscribers()

• Variant$remove_subscriber()

• Variant$add_subscribers()

• Variant$render()

• Variant$renderings()

• Variant$update_variant()

• Variant$jobs()

• Variant$job()

• Variant$get_url()

• Variant$get_url_rev()

• Variant$get_dashboard_url()

• Variant$print()

• Variant$clone()

Method get_variant_remote()

Get the underlying variant data.

Get and store the (remote) variant data.

Usage

Variant$get_variant_remote()

Method new()

Initialize this variant.

Usage

Variant$new(connect, content, key)

Arguments

Method send_mail()

Mail previously rendered content.

Usage

Variant$send_mail(to = c("me", "collaborators", "collaborators_viewers"))

Arguments

Method get_schedule()

Get the (remote) schedule data.

Usage

Variant$get_schedule()

Method get_schedule_remote()

Get the (remote) schedule data.

Usage

Variant$get_schedule_remote()

Method get_subscribers()

Get the subscribers.

Usage

Variant$get_subscribers()

Method remove_subscriber()

Remove a named subscriber.

Usage

Variant$remove_subscriber(guid)

Arguments

Method add_subscribers()

Add named subscribers.

Usage

Variant$add_subscribers(guids)

Arguments

Method render()

Render this variant.

Usage

Variant$render()

Method renderings()

List the renderings of this variant.

Usage

Variant$renderings()

Method update_variant()

Update this variant.

Usage

Variant$update_variant(...)

Arguments

Method jobs()

Jobs for this variant.

Usage

Variant$jobs()

Method job()

Return single job for this variant.

Usage

Variant$job(key)

Arguments

Method get_url()

Return the URL for this variant.

Usage

Variant$get_url()

Method get_url_rev()

Return the URL associated with one rendering for this variant.

Usage

Variant$get_url_rev(rev)

Arguments

Method get_dashboard_url()

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

Usage

Variant$get_dashboard_url(pane = "access")

Arguments

Method print()

Print this object.

Usage

Variant$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

Variant$clone(deep = FALSE)

Arguments

See Also

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

VariantSchedule

Description

VariantSchedule

VariantSchedule

Details

An R6 class that represents a Schedule

Super classes

connectapi::Content -> connectapi::Variant -> VariantSchedule

Public fields

Methods

Public methods

• VariantSchedule$new()

• VariantSchedule$GET()

• VariantSchedule$POST()

• VariantSchedule$DELETE()

• VariantSchedule$set_schedule()

• VariantSchedule$is_empty()

• VariantSchedule$print()

• VariantSchedule$get_schedule()

• VariantSchedule$get_schedule_remote()

• VariantSchedule$describe_schedule()

• VariantSchedule$clone()

Method new()

Initialize this schedule.

Usage

VariantSchedule$new(connect, content, key, schedule)

Arguments

Method GET()

Perform an HTTP GET request of the named API path. Returns an object parsed from the HTTP response.

Usage

VariantSchedule$GET(path)

Arguments

Method POST()

Perform an HTTP POST request of the named API path. Returns an object parsed from the HTTP response.

Usage

VariantSchedule$POST(path, body)

Arguments

Method DELETE()

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

Usage

VariantSchedule$DELETE(path)

Arguments

Method set_schedule()

Set the schedule for this variant

Usage

VariantSchedule$set_schedule(...)

Arguments

Method is_empty()

Return if this variant has a schedule.

Usage

VariantSchedule$is_empty()

Method print()

Print this object.

Usage

VariantSchedule$print(...)

Arguments

Method get_schedule()

Get the schedule data.

Usage

VariantSchedule$get_schedule()

Method get_schedule_remote()

Get and store the (remote) schedule data.

Usage

VariantSchedule$get_schedule_remote()

Method describe_schedule()

Description of the associated schedule.

Usage

VariantSchedule$describe_schedule()

Method clone()

The objects of this class are cloneable with this method.

Usage

VariantSchedule$clone(deep = FALSE)

Arguments

See Also

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

VariantTask

Description

VariantTask

VariantTask

Details

An R6 class that represents a Variant Task

Super classes

connectapi::Content -> connectapi::Variant -> VariantTask

Public fields

Methods

Public methods

• VariantTask$new()

• VariantTask$get_task()

• VariantTask$add_data()

• VariantTask$get_data()

• VariantTask$print()

• VariantTask$clone()

Method new()

Initialize this variant task.

Usage

VariantTask$new(connect, content, key, task)

Arguments

Method get_task()

Return the underlying task.

Usage

VariantTask$get_task()

Method add_data()

Set the data.

Usage

VariantTask$add_data(data)

Arguments

Method get_data()

Get the data.

Usage

VariantTask$get_data()

Method print()

Print this object.

Usage

VariantTask$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

VariantTask$clone(deep = FALSE)

Arguments

See Also

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

Convert content list to a data frame

Description

Converts a list returned by search_content() into a data frame.

Usage

## S3 method for class 'connect_content_list'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)

Arguments

Value

A data.frame with one row per content item.

Convert integrations list to a data frame

Description

Converts a list returned by get_integrations() into a data frame.

Usage

## S3 method for class 'connect_integration_list'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)

Arguments

Value

A data.frame with one row per integration.

Convert usage data to a data frame

Description

Converts an object returned by get_usage() into a data frame with parsed column types. By default, extracts path and user_agent from the data field, if available.

Usage

## S3 method for class 'connect_list_hits'
as.data.frame(x, row.names = NULL, optional = FALSE, ..., unnest = TRUE)

Arguments

Value

A data.frame with one row per usage record.

Convert objects to integration class

Description

Convert objects to integration class

Usage

as_integration(x, client)

Arguments

Value

An integration object. The object has all the fields from the integrations endpoint (see get_integrations()) and a Connect client as a client attribute (attr(x, "client"))

Convert integration list to a tibble

Description

Converts a list returned by search_content() to a tibble.

Usage

## S3 method for class 'connect_content_list'
as_tibble(x, ...)

Arguments

Value

A tibble with one row per content item.

Convert integration list to a tibble

Description

Converts a list returned by get_integrations() to a tibble.

Usage

## S3 method for class 'connect_integration_list'
as_tibble(x, ...)

Arguments

Value

A tibble with one row per integration.

Convert usage data to a tibble

Description

Converts an object returned by get_usage() to a tibble via as.data.frame.connect_list_hits().

Usage

## S3 method for class 'connect_list_hits'
as_tibble(x, ...)

Arguments

Value

A tibble with one row per usage record.

Audit Access Controls

Description

Usage

audit_access_open(content, type = "all")

Arguments

See Also

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

Audit R Versions

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()

Audit Run As Settings

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()

Browse

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

Define a bundle from a Directory

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"))

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

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"))

Define a bundle from a static file (or files)

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"))

Create a connection to Posit Connect

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_),
  token,
  token_local_testing_key = api_key,
  prefix = "CONNECT",
  audience = NULL,
  ...,
  .check_is_fatal = TRUE
)

Arguments

Details

When running on Connect, the client's environment will contain default CONNECT_SERVER and CONNECT_API_KEY variables. The API key's permissions are scoped to the publishing user's account.

To create a client with permissions scoped to the content visitor's account, call connect() passing a user session token from content session headers to the token argument. To do this, you must first add a Connect API integration in your published content's Access sidebar.

Value

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

Examples

## Not run: 
client <- connect()

# Running in Connect, create a client using the content visitor's account.
# This example assumes code is being executed in a Shiny app's `server`
# function with a `session` object available.
token <- session$request$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN
client <- connect(token = token)

# Test locally with an API key using a different role.
fallback_key <- Sys.getenv("VIEWER_ROLE_API_KEY")
client <- connect(token = token, token_local_testing_key = fallback_key)

## 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")

Delete Content

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Get Content Item

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Examples

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

## End(Not run)

Content List

Description

Get a content list

Usage

content_list_by_tag(src, tag)

Arguments

Details

content_list_by_tag() retrieves a content list by tag

Get Content List with Permissions

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)

Render a content item.

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)

Restart a content item.

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)

Get Content Title

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Update Content

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Create an OAuth integration

Description

Creates a new OAuth integration on the Posit Connect server. OAuth integrations allow content to access external resources using OAuth credentials.

You must have administrator privileges to perform this action.

See the Posit Connect documentation on OAuth integrations for more information.

Usage

create_integration(client, name, description = NULL, template, config)

Arguments

Value

A connect_integration object representing the newly created integration. See get_integration() for details on the returned object.

See Also

get_integrations(), get_integration(), update_integration(), delete_integration()

Other oauth integration functions: delete_integration(), get_associations(), get_integration(), get_integrations(), set_integrations(), update_integration()

Examples

## Not run: 
client <- connect()

# Create a GitHub OAuth integration
github_integration <- create_integration(
  client,
  name = "GitHub Integration",
  description = "Integration with GitHub for OAuth access",
  template = "github",
  config = list(
    client_id = "your-client-id",
    client_secret = "your-client-secret"
  )
)

# Create a custom OAuth integration
custom_integration <- create_integration(
  client,
  name = "Custom API Integration",
  description = "Integration with our custom API",
  template = "custom",
  config = list(
    auth_mode = "Confidential",
    auth_type = "Viewer",
    authorization_uri = "https://api.example.com/oauth/authorize",
    client_id = "your-client-id",
    client_secret = "your-client-secret",
    token_uri = "https://api.example.com/oauth/token"
  )
)

## End(Not run)

Create Random Name

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Build a Dashboard URL from a Content Item

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Delete an OAuth integration

Description

Deletes an OAuth integration from the Posit Connect server. This permanently removes the integration and any associated content associations.

You must have administrator privileges to perform this action.

See the Posit Connect documentation on OAuth integrations for more information.

Usage

delete_integration(integration)

Arguments

Value

Returns NULL invisibly if successful.

See Also

get_integrations(), get_integration(), create_integration(), update_integration()

Other oauth integration functions: create_integration(), get_associations(), get_integration(), get_integrations(), set_integrations(), update_integration()

Examples

## Not run: 
client <- connect()

# Get an integration to delete
integration <- get_integration(client, "your-integration-guid")

# Delete the integration
delete_integration(integration)

## End(Not run)

Delete a runtime cache

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)

Delete content item thumbnail

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(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Examples

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

## End(Not run)

Delete the Vanity URL

Description

Delete 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(), delete_thumbnail(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Deploy a bundle

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)

Deploy a Git Repository

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(), delete_thumbnail(), delete_vanity_url(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Download a Bundle from Deployed Connect Content

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()

Get OAuth associations for a piece of content

Description

Given a Content object, retrieves a list of its OAuth associations. An association contains a content GUID and an association GUID, and indicates that the integration can be used by the content when it runs.

Usage

get_associations(x)

Arguments

Value

A list of OAuth integration associations. Each association includes details such as:

• app_guid: The content item's GUID (deprecated, use content_guid instead).

• content_guid: The content item's GUID.

• oauth_integration_guid: The GUID of the OAuth integration.

• oauth_integration_name: The name of the OAuth integration.

• oauth_integration_description: A description of the OAuth integration.

• oauth_integration_template: The template used for this OAuth integration.

• oauth_integration_auth_type: The authentication type (e.g., "Viewer" or "Service Account").

• created_time: The timestamp when the association was created.

See Also

set_integrations(), get_integrations(), get_integration()

Other oauth integration functions: create_integration(), delete_integration(), get_integration(), get_integrations(), set_integrations(), update_integration()

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_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Examples

## Not run: 
client <- connect()

# Get OAuth associations for an app.
my_app <- content_item(client, "12345678-90ab-cdef-1234-567890abcdef")
my_app_associations <- get_associations(my_app)

# Given those associations, retrieve the integrations themselves.
my_app_integrations <- purrr::map(
  my_app_associations,
  ~ get_integration(client, .x$oauth_integration_guid)
)

## End(Not run)

Get Audit Logs from Posit Connect Server

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)

Obtain AWS credentials for your content.

Description

Obtain AWS credentials for your content.

Usage

get_aws_content_credentials(
  connect,
  content_session_token = NULL,
  audience = NULL
)

Arguments

Details

Please see https://docs.posit.co/connect/user/oauth-integrations/#obtaining-service-account-aws-credentials for more information. See the example below of using this function with paws to access S3. Any library that allows you to pass AWS credentials will be able to utilize the credentials returned from this function call.

Value

The AWS credentials as a list with fields named access_key_id, secret_access_key, session_token, and expiration.

Examples

## Not run: 
library(connectapi)
library(paws)

client <- connect()
# Pulls the content session token from the environment
# when deployed into Connect.
aws_credentials <- get_aws_content_credentials(client)

# Create S3 client with AWS credentials from Connect
svc <- paws::s3(
  credentials = list(
    creds = list(
      access_key_id = aws_credentials$access_key_id,
      secret_access_key = aws_credentials$secret_access_key,
      session_token = aws_credentials$session_token
    )
  )
)

# Get object from S3
obj <- svc$get_object(
  Bucket = "my-bucket",
  Key = "my-data.csv"
)

## End(Not run)

Obtain a visitor's AWS credentials

Description

Obtain a visitor's AWS credentials

Usage

get_aws_credentials(connect, user_session_token, audience = NULL)

Arguments

Details

Please see https://docs.posit.co/connect/user/oauth-integrations/#obtaining-service-account-aws-credentials for more information. See the example below of using this function in a Plumber API with paws to access S3. Any library that allows you to pass AWS credentials will be able to utilize the credentials returned from this function call.

Value

The AWS credentials as a list with fields named access_key_id, secret_access_key, session_token, and expiration.

Examples

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

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

  # Create S3 client with AWS credentials from Connect
  svc <- paws::s3(
    credentials = list(
      creds = list(
        access_key_id = aws_credentials$access_key_id,
        secret_access_key = aws_credentials$secret_access_key,
        session_token = aws_credentials$session_token
      )
    )
  )

  # Get object from S3
  obj <- svc$get_object(
    Bucket = "my-bucket",
    Key = "my-data.csv"
  )

  "done"
}

## End(Not run)

Get Bundles

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_environment(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Get information about content on the Posit Connect server

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 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.

• vanity_url: The vanity URL associated with this content item.

• id: The internal numeric identifier of this content item.

• tags: Tags associated with this content item. Each entry is a list with the following fields:

  • id: The identifier for the tag.

  • name: The name of the tag.

  • parent_id: The identifier for the parent tag. Null if the tag is a top-level tag.

  • created_time: The timestamp (RFC3339) indicating when the tag was created.

  • updated_time: The timestamp (RFC3339) indicating when the tag was last updated.

• owner: Basic details about the owner of this content item. Each entry is a list with the following fields:

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

  • username: The user's username.

  • first_name: The user's first name.

  • last_name: The user's last name.

Examples

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

get_content(client)

## End(Not run)

Package dependencies for a content item

Description

Get a data frame of package dependencies used by a content item.

Usage

get_content_packages(content)

Arguments

Value

A data frame with the following columns:

• language : Language ecosystem the package belongs to (r or python)

• name: The package name

• version: The package version

• hash: For R packages, the package DESCRIPTION hash

See Also

Other packages functions: get_packages()

Examples

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

## End(Not run)

Manage Environment Variables

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_image(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Get content access permissions for a group or groups

Description

Get content access permissions for a group or groups

Usage

get_group_content(src, guids)

Arguments

Value

A tibble with the following columns:

• group_guid: The group's GUID

• group_name: The group's name

• content_guid: The content item's GUID

• content_name: The content item's name

• content_title: The content item's title

• access_type: The access type of the content item ("all", "logged_in", or "acl")

• role: The access type that members of the group have to the content item, "publisher" or "viewer".

See Also

Other groups functions: get_group_members(), get_groups()

Examples

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

# Get a data frame of groups
groups <- get_groups(client)

# Get permissions for a single group by passing in the corresponding row.
get_group_content(client, groups[1, "guid"])
dplyr::filter(groups, name = "research_scientists") %>%
  dplyr::pull(guid) %>%
  get_group_content(client, .)

# Get permissions for all groups by passing in all group guids.
get_group_content(client, groups$guid)

## End(Not run)

Get users within a specific group

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

See Also

Other groups functions: get_group_content(), get_groups()

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)

Get group information from the Posit Connect server

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.

See Also

Other groups functions: get_group_content(), get_group_members()

Examples

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

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

## End(Not run)

Get the Content Image

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(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_job(), get_jobs(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Get the details of an OAuth integration

Description

Given the GUID of an OAuth integration available on a Connect server, retrieve its details. You must have administrator or publisher privileges to perform this action.

Usage

get_integration(client, guid)

Arguments

Value

A connect_integration object representing an OAuth integration, which has the following fields:

• id: The internal identifier of this OAuth integration.

• guid: The GUID of this OAuth integration.

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

• updated_time: The timestamp (RFC3339) indicating when this integration was last updated

• name: A descriptive name to identify the OAuth integration.

• description: A brief text to describe the OAuth integration.

• template: The template used to configure this OAuth integration.

• auth_type: The authentication type indicates which OAuth flow is used by this integration.

• config: A list with the OAuth integration configuration. Fields differ between integrations.

See Also

get_integrations(), get_associations(), set_integrations()

Other oauth integration functions: create_integration(), delete_integration(), get_associations(), get_integrations(), set_integrations(), update_integration()

Examples

## Not run: 
client <- connect()
x <- get_integration(client, guid)

## End(Not run)

Get OAuth integrations

Description

Retrieve OAuth integrations either from the Connect server or associated with a specific content item.

If x is a Connect object, this function lists all OAuth integrations on the server. If x is a Content object, it returns the integrations associated with that content item.

You must have administrator or publisher privileges to use this function.

Usage

get_integrations(x)

Arguments

Value

A list of class connect_integration_list, where each element is a connect_integration object with the following fields. (Raw API fields are character strings unless noted otherwise):

• id: The internal identifier of this OAuth integration.

• guid: The GUID of this OAuth integration.

• created_time: Timestamp (RFC3339) when the integration was created.

• updated_time: Timestamp (RFC3339) when the integration was last updated.

• name: A descriptive name.

• description: A brief description.

• template: The template used to configure the integration.

• auth_type: The OAuth flow used.

• config: A list with integration-specific config fields.

Use as.data.frame() or tibble::as_tibble() to convert the result to a data frame with parsed types.

See Also

get_integration(), set_integrations(), get_associations()

Other oauth integration functions: create_integration(), delete_integration(), get_associations(), get_integration(), set_integrations(), update_integration()

Examples

## Not run: 
# From a Connect client
client <- connect()
integrations <- get_integrations(client)

# Filter or update specific ones
github_integration <- purrr::keep(integrations, \(x) x$template == "github")[[1]]

json_payload <- jsonlite::toJSON(list(
  description = "Updated Description",
  config = list(client_secret = "new-secret")
), auto_unbox = TRUE)

client$PATCH(
  paste0("v1/oauth/integrations/", github_integration$guid),
  body = json_payload
)

# From a Content item
content <- content_item(client, "12345678-90ab-cdef-1234-567890abcdef")
content_integrations <- get_integrations(content)

# Filter content integrations
snowflake_integrations <- purrr::keep(content_integrations, ~ .x$template == "snowflake")

## End(Not run)

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

Description

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

Usage

get_job(content, key)

Arguments

See Also

Other job functions: get_jobs(), get_log(), terminate_jobs()

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

Get Jobs

Description

Retrieve details about server processes associated with a content_item, such as a FastAPI app or a Quarto render.

Usage

get_jobs(content)

get_job_list(content)

Arguments

Details

Note that Connect versions below 2022.10.0 use a legacy endpoint, and will not return the complete set of information provided by newer versions.

get_jobs() returns job data as a data frame, whereas get_jobs_list() returns job data in a list.

You might get job data as a data frame if you want to perform some calculations about job data (e.g. counting server processes over time), or if you want to filter jobs to find a specific key.

The objects in list returned by get_jobs_list() are useful if you want to take an action on a job, such as getting its process log with get_log().

Value

• get_jobs(): A data frame with a row representing each job.

• get_job_list(): A list with each element representing a job.

Jobs contain the following fields:

• id: The job identifier.

• ppid: The job's parent process identifier (see Note 1).

• pid: The job's process identifier.

• key: The job's unique key identifier.

• remote_id: The job's identifier for off-host execution configurations (see Note 1).

• app_id: The job's parent content identifier; deprecated in favor of content_id.

• app_guid: The job's parent content GUID; deprecated in favor of content_guid.

• content_id: The job's parent content identifier.

• content_guid: The job's parent content GUID.

• variant_id: The identifier of the variant owning this job.

• bundle_id: The identifier of a content bundle linked to this job.

• start_time: The timestamp (RFC3339) indicating when this job started.

• end_time: The timestamp (RFC3339) indicating when this job finished.

• last_heartbeat_time: The timestamp (RFC3339) indicating the last time this job was observed to be running (see Note 1).

• queued_time: The timestamp (RFC3339) indicating when this job was added to the queue to be processed. Only scheduled reports will present a value for this field (see Note 1).

• queue_name: The name of the queue which processes the job. Only scheduled reports will present a value for this field (see Note 1).

• tag: A tag to identify the nature of the job.

• exit_code: The job's exit code. Present only when job is finished.

• status: The current status of the job. On Connect 2022.10.0 and newer, one of Active: 0, Finished: 1, Finalized: 2; on earlier versions, Active: 0, otherwise NA.

• hostname: The name of the node which processes the job.

• cluster: The location where this content runs. Content running on the same server as Connect will have either a null value or the string Local. Gives the name of the cluster when run external to the Connect host (see Note 1).

• image: The location where this content runs. Content running on the same server as Connect will have either a null value or the string Local. References the name of the target image when content runs in a clustered environment such as Kubernetes (see Note 1).

• run_as: The UNIX user that executed this job.

Note

1. On Connect instances earlier than 2022.10.0, these fields will contain NA values.

See Also

Other job functions: get_job(), get_log(), terminate_jobs()

Other content functions: content_delete(), content_item(), content_title(), content_update(), create_random_name(), dashboard_url(), delete_thumbnail(), delete_vanity_url(), deploy_repo(), get_associations(), get_bundles(), get_environment(), get_image(), get_job(), get_log(), get_thumbnail(), get_vanity_url(), git, has_thumbnail(), lock_content(), permissions, search_content(), set_image_path(), set_integrations(), set_run_as(), set_thumbnail(), set_vanity_url(), swap_vanity_url(), swap_vanity_urls(), terminate_jobs(), verify_content_name()

Examples

## Not run: 
client <- connect()
item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
jobs <- get_jobs(item)
job_list <- get_job_list(item)

## End(Not run)

Get Job Log

Description

Get the log output for a job. Requires Connect 2022.10.0 or newer.

Usage

get_log(job, max_log_lines = NULL)

Arguments

Details

Note: The output of get_jobs() cannot be used with get_log(). Please use an object from the list returned by get_job_list().

Value

A data frame with the requested log. Each row represents an entry.

• source: stdout or stderr

• timestamp: The time of the entry.

• data: The logged text.

See Also

Other job functions: get_job(), get_jobs(), terminate_jobs()

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

Examples

## Not run: 
client <- connect()
item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
jobs <- get_job_list(item)
log <- get_log(jobs[[1]])

## End(Not run)

Perform an OAuth credential exchange to obtain a content-specific OAuth access token.

Description

Perform an OAuth credential exchange to obtain a content-specific OAuth access token.

Usage

get_oauth_content_credentials(
  connect,
  content_session_token = NULL,
  requested_token_type = NULL,
  audience = NULL
)

Arguments

Details

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

Value

The OAuth credential exchange response.

See Also

get_integrations(), get_oauth_credentials()

Examples

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

#* @get /do
function(req) {
  credentials <- get_oauth_content_credentials(client)

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

  "done"
}

## End(Not run)

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

Description

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

Usage

get_oauth_credentials(
  connect,
  user_session_token,
  requested_token_type = NULL,
  audience = NULL
)

Arguments