⇧ Back to top

RStudio Connect API Reference 1.0.0

Build 1.7.0-11

This is a reference document explaining the RStudio Connect API. Please note that paths are relative to the base API URL (i.e., http:/localhost:3939/__api__/v1)

Endpoints

The URIs for all endpoints below must be prefixed with /__api__/v1 to function properly. Unless otherwise noted, all endpoints which accept a request body will require the body to be in application/json format. Similarly, all response bodies will be returned in application/json format.

Audit Logs

get   /audit_logs Get audit logs
Operation ID: getAuditLogs

Parameters
limit integer (int32) (query)
previous string (query)
next string (query)
ascOrder boolean (query)

200 AuditLogs
400
401 APIError
403 APIError
404 APIError
500
default APIError

Content

This group of endpoints is experimental and will be removed, renamed, or altered in an upcoming release.
post   /experimental/content Create content item
Operation ID: createContent

This endpoint is experimental and will be removed, renamed, or altered in an upcoming release.

The request body must be provided in multipart/form-data format.

Parameters
content Content (body) (required)

200 Content
400
401 APIError
403 APIError
404 APIError
500
get   /experimental/content/{guid} Get content details
Operation ID: getContent

This endpoint is experimental and will be removed, renamed, or altered in an upcoming release.
Parameters
guid string (path) (required)

200 Content
400
401 APIError
404 APIError
500
post   /experimental/content/{guid}/deploy Deploy deployment bundle
Operation ID: deployContentBundle

This endpoint is experimental and will be removed, renamed, or altered in an upcoming release.
Parameters
guid string (path) (required)
instructions ContentDeploymentInstructions (body)

200 ContentDeploymentTask
400
401 APIError
404 APIError
500
post   /experimental/content/{guid}/upload Upload deployment bundle
Operation ID: uploadContentBundle

This endpoint is experimental and will be removed, renamed, or altered in an upcoming release.
Parameters
guid string (path) (required)
archive string (binary) (body) (required)
X-Content-Checksum string (header)

200 ContentUploadBundle
400
401 APIError
404 APIError
500

Groups

Operation ID: getGroups

Parameters
prefix string (query)
page_number integer (int32) (query)
page_size integer (int32) (query)
asc_order boolean (query)

200 Groups
400
401 APIError
500
default APIError
post   /groups Create a group from caller-supplied details (password, OAuth2)
Operation ID: createGroup

Parameters
group (see below) (body) (required)

Body Schema

The body for this request must be specified as follows:

name string (required)

Here is an example of what it may look like:

200 Group
400
401 APIError
403 APIError
404 APIError
409 APIError
500
get   /groups/{group_guid}/members Get group member details
Operation ID: getGroupMembers

Parameters
group_guid string (path) (required)

200 GroupMembers
400
401 APIError
404 APIError
500
post   /groups/{group_guid}/members Add a group member
Operation ID: addGroupMember

Parameters
group_guid string (path) (required)
user (see below) (body) (required)

Body Schema

The body for this request must be specified as follows:

user_guid string (required)

Here is an example of what it may look like:

204
400
401 APIError
403 APIError
404 APIError
409 APIError
500
delete   /groups/{group_guid}/members/{user_guid} Remove a group member
Operation ID: removeGroupMember

Parameters
group_guid string (path) (required)
user_guid string (path) (required)

204
400
401 APIError
403 APIError
404 APIError
500
get   /groups/{guid} Get group details
Operation ID: getGroup

Parameters
guid string (path) (required)

200 Group
400
401 APIError
404 APIError
500
delete   /groups/{guid} Delete a group
Operation ID: deleteGroup

Parameters
guid string (path) (required)

204
400
401 APIError
403 APIError
404 APIError
500

Instrumentation

get   /instrumentation/content/visits Get Content Visits
Operation ID: getContentVisits

Parameters
content_guid string (query)
min_data_version integer (int32) (query)
from string (query)
to string (query)
limit integer (int32) (query)
previous string (query)
next string (query)
asc_order boolean (query)

200 ContentVisitLogs
400
401 APIError
403 APIError
default APIError
get   /instrumentation/shiny/usage Get Shiny App Usage
Operation ID: getShinyAppUsage

Parameters
content_guid string (query)
min_data_version integer (int32) (query)
from string (query)
to string (query)
limit integer (int32) (query)
previous string (query)
next string (query)
asc_order boolean (query)

200 ShinyAppUsageLogs
400
401 APIError
403 APIError
default APIError

R Information

get   /server_settings/r Get R Information
Operation ID: getRInformation

200 RInstallations
401 APIError
403 APIError
default APIError

Tasks

This group of endpoints is experimental and will be removed, renamed, or altered in an upcoming release.
get   /experimental/tasks/{id} Get task details
Operation ID: getTask

This endpoint is experimental and will be removed, renamed, or altered in an upcoming release.
Parameters
id string (path) (required)
first integer (int32) (query)
wait integer (int32) (query)

200 Task
400
401 APIError
403 APIError
404 APIError
500

Users

Operation ID: getUsers

Parameters
prefix string (query)
user_role string (query)
account_status string (query)
page_number integer (int32) (query)
page_size integer (int32) (query)
asc_order boolean (query)

200 Users
400
401 APIError
403 APIError
404 APIError
500
default APIError
Operation ID: createPullUser

Parameters
request (see below) (body) (required)

Body Schema

The body for this request must be specified as follows:

temp_ticket string (required)

Here is an example of what it may look like:

200 User
400
401 APIError
403 APIError
404 APIError
409 APIError
500
post   /users Create a user from caller-supplied details (password, PAM, proxy)
Operation ID: createPushUser

Parameters
user (see below) (body) (required)

Body Schema

The body for this request must be specified as follows:

email string
first_name string
last_name string
password string
user_must_set_password boolean
user_role nullable string
username string (required)

Here is an example of what it may look like:

200 User
400
401 APIError
403 APIError
404 APIError
409 APIError
500
Operation ID: searchRemoteUsers

Parameters
prefix string (query) (required)
limit integer (int32) (query)

200 RemoteSearchResults
400
401 APIError
403 APIError
404 APIError
500
default APIError
get   /users/{guid} Get user details
Operation ID: getUser

Parameters
guid string (path) (required)

200 User
400
401 APIError
404 APIError
500
put   /users/{guid} Update a user
Operation ID: updateUser

Parameters
guid string (path) (required)
user (see below) (body) (required)

Body Schema

The body for this request must be specified as follows:

email string
first_name string
last_name string
user_role string
username string

Here is an example of what it may look like:

200 EditableUser
400
401 APIError
403 APIError
404 APIError
409 APIError
500
post   /users/{guid}/lock Lock a user
Operation ID: lockUser

Parameters
guid string (path) (required)
request (see below) (body) (required)

Body Schema

The body for this request must be specified as follows:

locked boolean (required)

Here is an example of what it may look like:

200
400
401 APIError
403 APIError
404 APIError
500

Models

APIError

code integer (required)
error string (required)
payload nullable object

Example

AuditEntry

action string (required)
event_description string (required)
id string (required)
time string (date-time) (required)
user_description string (required)
user_id string (required)

Example

AuditLogs

paging AuditPager
results array of AuditEntry

Example

AuditPager

cursors object (required)
next nullable string (required)
previous nullable string (required)

first nullable string (required)
last nullable string (required)
next nullable string (required)
previous nullable string (required)

Example

Content

This type is experimental and will be removed, renamed, or altered in an upcoming release.
access_type string
app_mode read-only string
bundle_id read-only nullable string
connection_timeout nullable integer
created_time read-only string (date-time)
description string
guid read-only string
has_parameters read-only boolean
idle_timeout nullable integer
init_timeout nullable integer
last_deployed_time read-only string (date-time)
load_factor nullable number
max_conns_per_process nullable integer
max_processes nullable integer
min_processes nullable integer
name string (required)
needs_config boolean
owner_guid read-only string
py_version read-only nullable string
r_version read-only nullable string
read_timeout nullable integer
role read-only string
run_as nullable string
run_as_current_user boolean
title nullable string
url read-only string

Example

ContentDeploymentInstructions

This type is experimental and will be removed, renamed, or altered in an upcoming release.
bundle_id nullable string

Example

ContentDeploymentTask

This type is experimental and will be removed, renamed, or altered in an upcoming release.
task_id read-only string

Example

ContentUploadBundle

This type is experimental and will be removed, renamed, or altered in an upcoming release.
bundle_id read-only string
size read-only number

Example

ContentVisit

bundle_id integer (required)
content_guid string (required)
data_version integer (required)
rendering_id integer
time string (required)
user_guid string (required)
variant_key string

Example

ContentVisitLogs

paging ContentVisitPager
results array of ContentVisit

Example

ContentVisitPager

cursors object (required)
next nullable string (required)
previous nullable string (required)

first nullable string (required)
last nullable string (required)
next nullable string (required)
previous nullable string (required)

Example

EditableUser

email string (required)
first_name string (required)
last_name string (required)
updated_time string (date-time) (required)
user_role string (required)
username string (required)

Example

Group

guid string (required)
name string (required)
owner_guid nullable string (required)

Example

GroupMembers

current_page integer:int32 (0 <= n)
results array of User
total integer

Example

Groups

current_page integer:int32 (0 <= n)
results array of Group
total integer

Example

RInstallation

version string

Example

RInstallations

installations array of RInstallation

Example

RemoteSearchResults

current_page integer:int32 (0 <= n)
results array of UserWithTicket
total integer

Example

ShinyAppUsage

content_guid string (required)
data_version integer (required)
ended string (required)
started string (required)
user_guid string (required)

Example

ShinyAppUsageLogs

paging ShinyAppUsagePager
results array of ShinyAppUsage

Example

ShinyAppUsagePager

cursors object (required)
next nullable string (required)
previous nullable string (required)

first nullable string (required)
last nullable string (required)
next nullable string (required)
previous nullable string (required)

Example

Task

This type is experimental and will be removed, renamed, or altered in an upcoming release.
code read-only integer
error read-only string
finished read-only boolean
id read-only string
last read-only integer
output read-only array of string

Example

User

active_time nullable string (date-time) (required)
confirmed boolean (required)
created_time string (date-time) (required)
email string (required)
first_name string (required)
guid string (required)
last_name string (required)
locked boolean (required)
updated_time string (date-time) (required)
user_role string (required)
username string (required)

Example

UserWithTicket

active_time nullable string (date-time) (required)
confirmed boolean (required)
created_time string (date-time) (required)
email string (required)
first_name string (required)
guid nullable string (required)
last_name string (required)
locked boolean (required)
temp_ticket string (required)
updated_time string (date-time) (required)
user_role string (required)
username string (required)

Example

Users

current_page integer:int32 (0 <= n)
results array of User
total integer

Example