Posit Connect

https://docs.posit.co/connect
Admin
Posit Connect is a publishing platform for deploying and sharing data science content built with...
Tokens:686,359
Snippets:8,621
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install and Prepare Blastula Example Files

Source: https://docs.posit.co/connect/user/rmarkdown

Install the blastula package and prepare example files for creating custom emails. This is the recommended starting point for most use cases.

```r
install.packages("blastula")
blastula::prepare_rsc_example_files()
```

--------------------------------

### Example Cleanup Script Setup

Source: https://docs.posit.co/connect/admin/programmatic-provisioning

This example demonstrates setting environment variables for a cleanup script after provisioning. It assumes provisioning has already been completed using a bootstrapped API key.

```bash
# Assume we have already completed provisioning using the bootstrapped api key
export BOOTSTRAP_API_KEY=bootstrapped_api_key
export CONNECT_SERVER=http://connect:8000/
```

--------------------------------

### Setup Virtual Environment and Install Dependencies

Source: https://docs.posit.co/connect/user/fastapi

Commands to create a Python virtual environment, activate it, upgrade pip, and install project dependencies from requirements.txt.

```bash
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip wheel setuptools
python -m pip install -r requirements.txt
```

--------------------------------

### Copy Example Landing Page Directory

Source: https://docs.posit.co/connect/admin/appendix/custom-landing

Copy the example landing page directory to a custom location outside the Posit Connect installation directory. This ensures your customizations are not overwritten during updates.

```bash
cp -r /opt/rstudio-connect/examples/landing-page \
    /usr/local/share/posit-connect-customizations/landing-page
```

--------------------------------

### Get Help for deployApp

Source: https://docs.posit.co/connect/user/publishing-r

Access detailed help documentation for the deployApp function, including usage, arguments, and examples.

```r
install.packages('rsconnect')
library(rsconnect)
?rsconnect::deployApp
```

--------------------------------

### Full Content Deployment Example

Source: https://docs.posit.co/connect/cookbook/operations/deploying-content

A comprehensive example demonstrating the entire process of creating content, creating a bundle, setting environment variables, deploying, and asserting successful completion.

```python
from posit import connect

NAME = "shakespeare"
TITLE = "Shakespeare Word Clouds"
BUNDLE_FILE_NAME = 'bundle.tar.gz'

client = connect.Client()
content = client.content.create(name=NAME, title=TITLE)
bundle = content.bundles.create(BUNDLE_FILE_NAME)
client.patch(f"v1/content/{content.guid}/environment", json=[{'name': 'DATABASE_URL', 'value': 'postgresql://localhost:5432'}])
task = bundle.deploy()
task.wait_for()
assert task.exit_code == 0
```

--------------------------------

### Get Content Packages in Python

Source: https://docs.posit.co/connect/cookbook/packages/viewing-content-packages

Fetches a list of packages installed for a specific content item using its GUID. Requires administrator or publisher privileges.

```python
from posit import connect

GUID = "154bd2af-e8fa-4aa4-aab8-dcef701f4af9"

client = connect.Client()
content = client.content.get(GUID)
packages = content.packages
```

--------------------------------

### Get Content Packages in R

Source: https://docs.posit.co/connect/cookbook/packages/viewing-content-packages

Retrieves a data frame of packages installed for a given content item using its GUID. Requires administrator or publisher privileges.

```r
library(connectapi)

CONTENT_GUID <- "dd219cd5-ab51-4f00-bbd5-715b8dae882b"

client <- connect()

item <- content_item(client, CONTENT_GUID)
packages <- get_content_packages(item)
```

--------------------------------

### Promote Content: Python Full Example

Source: https://docs.posit.co/connect/cookbook/operations/promoting-content-from-staging-to-production

This Python script demonstrates the complete process of promoting content from a staging to a production Posit Connect server. It includes client initialization, content retrieval, bundle download, and deployment.

```python
from posit import connect

BUNDLE_FILE_NAME = 'bundle.tar.gz'
BUNDLE_ID = '1000'
SOURCE_API_KEY = "0d23c00de05a787ec2079ef75a881cdb"
SOURCE_CONTENT_GUID = "154bd2af-e8fa-4aa4-aab8-dcef701f4af9"
SOURCE_URL = "https://staging.connect.example.com/"
TARGET_API_KEY = "f19eb24c1fde2370e621ccdaf347f15e"
TARGET_CONTENT_GUID = "2d178c46-4dca-40b0-bf22-a21e1cfb5b46"
TARGET_URL = "https://connect.example.com/"

source_client = connect.Client(api_key=SOURCE_API_KEY, url=SOURCE_URL)
target_client = connect.Client(api_key=TARGET_API_KEY, url=TARGET_URL)

source_content = source_client.content.get(SOURCE_CONTENT_GUID)
target_content = target_client.content.get(TARGET_CONTENT_GUID)

source_bundle = source_content.bundles.get(BUNDLE_ID)
source_bundle.download(BUNDLE_FILE_NAME)

target_bundle = target_content.bundles.create(BUNDLE_FILE_NAME)

deployment_task = target_bundle.deploy()
deployment_task.wait_for()
assert deployment_task.exit_code == 0
```

--------------------------------

### Get Example Thumbnail

Source: https://docs.posit.co/connect/api/openapi.yaml

Retrieves a thumbnail image for a specific example. This endpoint is used to get a visual representation of an example.

```APIDOC
## GET /v1/examples/{name}/thumbnail

### Description
Get example thumbnail.

### Method
GET

### Endpoint
/v1/examples/{name}/thumbnail

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the example.

### Responses
#### Success Response (200)
- Description: Successful response.

#### Error Response (404)
- Description: The requested object does not exist.

#### Error Response (500)
- Description: A server error occurred.
```

--------------------------------

### Get Content Runtime Settings

Source: https://docs.posit.co/connect/cookbook/content/viewing-content-runtime-settings

Retrieve a content item by its GUID and access its runtime version information for R, Quarto, and Python. Ensure you have the connectapi package installed and a client object initialized.

```r
guid <- "154bd2af-e8fa-4aa4-aab8-dcef701f4af9"

library(connectapi)
client <- connect()
item <- get_content(client, guid = guid)
item$r_version
item$quarto_version
item$py_version
```

--------------------------------

### Promote Content: R Full Example

Source: https://docs.posit.co/connect/cookbook/operations/promoting-content-from-staging-to-production

This R script provides a comprehensive example of promoting content from a staging to a production Posit Connect server. It chains together client initialization, content retrieval, bundle download, deployment, and task polling.

```r
library(connectapi)

SOURCE_API_KEY <- "0d23c00de05a787ec2079ef75a881cdb"
SOURCE_URL <- "https://staging.connect.example.com/"
SOURCE_CONTENT_GUID <- "154bd2af-e8fa-4aa4-aab8-dcef701f4af9"

TARGET_API_KEY <- "f19eb24c1fde2370e621ccdaf347f15e"
TARGET_URL <- "https://connect.example.com/"
TARGET_CONTENT_GUID <- "2d178c46-4dca-40b0-bf22-a21e1cfb5b46"

source_client <- connect(
  server = SOURCE_URL,
  api_key = SOURCE_API_KEY
)
target_client <- connect(
  server = TARGET_URL,
  api_key = TARGET_API_KEY
)

source_content <- content_item(source_client, SOURCE_CONTENT_GUID)

BUNDLE_FILE_NAME <- 'bundle.tar.gz'
source_bundle <- download_bundle(source_content, filename = BUNDLE_FILE_NAME)

deployment_task <- deploy(target_client, source_bundle, guid = TARGET_CONTENT_GUID)
poll_task(deployment_task)
```

--------------------------------

### Get Incremental Task Output

Source: https://docs.posit.co/connect/api

Fetch task output starting from a specific point (`first`). This example assumes the previous response had a `last` field value of 23. The `wait` parameter is used to poll for new output.

```http
/v1/tasks/CmsfmnfDDyRUrsAc?wait=5&first=23
```

--------------------------------

### Get Example Thumbnail

Source: https://docs.posit.co/connect/api

Downloads the thumbnail image for a specified example. Note: This endpoint is deprecated.

```APIDOC
## GET /v1/examples/{name}/thumbnail

### Description
Download the thumbnail image for the named example.

__
Warning 
This endpoint is deprecated.

**This endpoint is deprecated.**

### Method
GET

### Endpoint
/v1/examples/{name}/thumbnail

#### Parameters
- **name** (string) - Required - The name of the example.

#### Responses
- **200** : Successful response.
- **400** : The requested operation is invalid.
- **401** : The requested operation requires authentication.
- **403** : You do not have permission to perform this operation.
- **404** : The requested object does not exist.
- **500** : A server error occurred.

#### Error Object Structure (for 400, 401, 403, 404, 500)
- **code** (integer) - Required - The specific code for the type of error returned. See the API error codes reference for the full set of values.
- **error** (string) - Required - A description of the problem that was encountered.
- **payload** (object|null) - Additional error details, if any. The structure varies by error type.
```

--------------------------------

### Install and Activate Floating License Server

Source: https://docs.posit.co/connect/admin/licensing

Install the Posit Connect license server and activate a floating license key. Ensure you have the correct .deb package and your license key.

```bash
sudo dpkg -i connect-license-server-1.0.9-x86_64.deb
sudo connect-license-server activate <license-key>
sudo connect-license-server start
```

--------------------------------

### Get Content by GUID with Optional Fields

Source: https://docs.posit.co/connect/news

Retrieve specific content by its GUID and include optional fields.

```APIDOC
## GET /v1/content/<guid>

### Description
Retrieves specific content using its GUID and supports the `include` query parameter to populate optional fields.

### Method
GET

### Endpoint
/v1/content/<guid>

### Query Parameters
- **include** (string) - Optional - Specifies optional fields to include in the result. Allowed options are `owner`, `tags`, `vanity_url`.
```

--------------------------------

### Deploy Example Dash App from GitHub

Source: https://docs.posit.co/connect/user/dash

Clone the example repository and deploy the Dash app using rsconnect-python. Ensure you replace '<saved server name>' with your actual server name and specify the correct entrypoint.

```bash
git clone https://github.com/sol-eng/python-examples
rsconnect deploy dash \
    -n <saved server name> \
    --entrypoint app:app \
    python-examples/dash-app/
```

--------------------------------

### Deploy Example App to Posit Connect

Source: https://docs.posit.co/connect/user/gradio

Command to deploy the saved Gradio application file to Posit Connect.

```bash
rsconnect deploy gradio -n <saved server name> app.py
```

--------------------------------

### Get User by GUID (Python)

Source: https://docs.posit.co/connect/cookbook/users/viewing-user-information

Use the `users.get` method to retrieve a user by their unique identifier (guid).

```APIDOC
## Get User by GUID

### Description
Retrieves a specific user's information using their unique GUID.

### Method
`client.users.get(guid)`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the user.

### Request Example
```python
from posit import connect

GUID = "f155520a-ca2e-4084-b0a0-12120b7d1add"

client = connect.Client()
user = client.users.get(GUID)
```

### Response
#### Success Response (200)
- **email** (string) - The user's email address.
- **username** (string) - The user's username.
- **first_name** (string) - The user's first name.
- **last_name** (string) - The user's last name.
- **user_role** (string) - The role assigned to the user.
- **created_time** (string) - The timestamp when the user was created.
- **updated_time** (string) - The timestamp when the user was last updated.
- **active_time** (string) - The timestamp of the user's last activity.
- **confirmed** (boolean) - Indicates if the user's email has been confirmed.
- **locked** (boolean) - Indicates if the user account is locked.
- **guid** (string) - The unique identifier for the user.

#### Response Example
```json
{
    "email": "hadley@posit.co",
    "username": "hadley",
    "first_name": "Hadley",
    "last_name": "Wickham",
    "user_role": "publisher",
    "created_time": "2017-03-08T04:52:04Z",
    "updated_time": "2023-02-17 16:23:09",
    "active_time": "2023-02-17 16:23:09",
    "confirmed": true,
    "locked": false,
    "guid": "f155520a-ca2e-4084-b0a0-12120b7d1add"
}
```
```

--------------------------------

### Create Project Directory

Source: https://docs.posit.co/connect/user/fastapi

Creates and navigates into a new directory for the FastAPI HTML example project.

```bash
mkdir fastapi-html-example
cd fastapi-html-example
```

--------------------------------

### Install Python Pandas Package

Source: https://docs.posit.co/connect/user/scripts

Install the pandas library for Python. This is a prerequisite for running Python script examples.

```bash
python3 -m pip install pandas
```

--------------------------------

### Retrieve Session by GUID (R)

Source: https://docs.posit.co/connect/cookbook/oauth-integrations/viewing-session-information

Use the `$GET()` method with the `connectapi` R package to fetch session details by its GUID.

```APIDOC
## GET /v1/oauth/sessions/{guid}

### Description
Retrieves a specific OAuth session's information using its unique GUID.

### Method
GET

### Endpoint
/v1/oauth/sessions/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the session to retrieve.

### Request Example
```R
library(connectapi)

GUID <- "8f7b293d-2078-439a-bb0e-469e13d4d38d"

client <- connect()
session <- client$GET(paste0("v1/oauth/sessions/", GUID))
```

### Response
#### Success Response (200)
- **id** (string) - The internal ID of the session.
- **guid** (string) - The unique GUID of the session.
- **user_guid** (string) - The GUID of the user associated with the session.
- **oauth_integration_guid** (string) - The GUID of the OAuth integration.
- **has_refresh_token** (boolean) - Indicates if the session has a refresh token.
- **created_time** (string) - The timestamp when the session was created.
- **updated_time** (string) - The timestamp when the session was last updated.

#### Response Example
```json
{
  "id": "13",
  "guid": "8f7b293d-2078-439a-bb0e-469e13d4d38d",
  "user_guid": "2aa02212-e7ee-4689-966f-0bd8a195cfc7",
  "oauth_integration_guid": "153a3d3f-e436-4502-8a5f-01fbb5def977",
  "has_refresh_token": true,
  "created_time": "2024-07-14T21:50:46Z",
  "updated_time": "2024-07-14T21:53:39Z"
}
```
```

--------------------------------

### Full Blue-Green Deployment Example (Python)

Source: https://docs.posit.co/connect/cookbook/operations/blue-green-deployments

A complete script to fetch both blue and green content, then assign the blue content's vanity URL to the green content, performing the traffic switch.

```python
from posit import connect

BLUE_CONTENT_GUID = "154bd2af-e8fa-4aa4-aab8-dcef701f4af9"
GREEN_CONTENT_GUID = "2d178c46-4dca-40b0-bf22-a21e1cfb5b46"

client = connect.Client()
blue = client.content.get(BLUE_CONTENT_GUID)
green = client.content.get(GREEN_CONTENT_GUID)
green.create_vanity(blue.vanity, force=True)
```

--------------------------------

### Initialize Posit Connect Client with Inline Credentials (R)

Source: https://docs.posit.co/connect/cookbook/getting-started/initializing-a-client

Create a client instance by providing the server URL and API key as arguments. This method is less secure than using environment variables.

```r
library(connectapi)

CONNECT_SERVER = "https://connect.example.com"
CONNECT_API_KEY = "abcdefghijklmnopqrstuvwxyz123456"

client <- connect(server = CONNECT_SERVER, api_key = CONNECT_API_KEY)
```

--------------------------------

### Get User by GUID in Python

Source: https://docs.posit.co/connect/cookbook/users/viewing-user-information

Use the `users.get` method to retrieve a specific user's information by their unique identifier (GUID).

```python
from posit import connect

GUID = "f155520a-ca2e-4084-b0a0-12120b7d1add"

client = connect.Client()
user = client.users.get(GUID)
```

```python
import json
print(json.dumps(user, indent=4))
```

--------------------------------

### Initialize Posit Connect Client with Inline Credentials (Python)

Source: https://docs.posit.co/connect/cookbook/getting-started/initializing-a-client

Create a client instance by providing the server URL and API key directly in the code. Use with caution to avoid exposing credentials.

```python
from posit import connect

CONNECT_SERVER = "https://connect.example.com"
CONNECT_API_KEY = "abcdefghijklmnopqrstuvwxyz123456"

client = connect.Client(CONNECT_SERVER, CONNECT_API_KEY)
```

--------------------------------

### Display All Groups in R

Source: https://docs.posit.co/connect/cookbook/groups/finding-groups

This example shows the output of `get_groups(client)`, typically displayed as a tibble with group details including GUID, name, and owner GUID.

```r
> all_groups
# A tibble: 2 × 3
   guid                                 name            owner_guid                          
   <chr>                                <chr>           <chr>                               
 1 c6beca6e-0898-4c27-b295-8beec58735d7 Data Scientists 4d81b29b-a2b2-41d3-8ef5-32cc5f63e679
 2 8071ec0e-9be2-4c26-a829-4f60a21ccb94 Data Engineers  4b03b981-0cfc-4d51-8dd4-a5521fe6dfb0
```

--------------------------------

### Examine Nameservice Installation Script

Source: https://docs.posit.co/connect/admin/nameservice

View the contents of the nameservice installation script to understand its actions before execution.

```bash
cat /opt/rstudio-connect/extras/nameservice/activate-nameservice.sh
```

--------------------------------

### Include Bookmarked Status in Content Retrieval

Source: https://docs.posit.co/connect/news

The `GET /v1/content/` and `GET /v1/content/{guid}` endpoints support `include=bookmarked` to indicate whether content is bookmarked by the requesting user.

```APIDOC
## Get Content with Bookmark Status

### Description
Retrieve content information, including whether it is bookmarked by the current user.

### Method
GET

### Endpoint
/v1/content/
/v1/content/{guid}

### Query Parameters
- **include** (string) - Optional - Set to `bookmarked` to include bookmark status for the requesting user.
```

--------------------------------

### Initialize Posit Connect Client with Environment Variables (Python)

Source: https://docs.posit.co/connect/cookbook/getting-started/initializing-a-client

Import the 'connect' module and create a client instance. The client automatically reads credentials from environment variables.

```python
from posit import connect

client = connect.Client()
```

--------------------------------

### Install Dependencies and Deploy

Source: https://docs.posit.co/connect/user/nodejs

Commands to install production dependencies using npm and then deploy the Node.js application to Posit Connect.

```bash
npm install
rsconnect deploy nodejs -n myServer ./
```

--------------------------------

### Install Nameservice Module

Source: https://docs.posit.co/connect/admin/nameservice

Run the nameservice installation script as root to install the module on the Linux server.

```bash
sudo /opt/rstudio-connect/extras/nameservice/activate-nameservice.sh
```

--------------------------------

### Get Package Dependencies

Source: https://docs.posit.co/connect/api/openapi.yaml

Retrieves the dependencies for a given content package identified by its GUID.

```APIDOC
## GET /v1/content/{guid}/dependencies

### Description
Get package dependencies.

### Method
GET

### Endpoint
/v1/content/{guid}/dependencies

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the content package.

### Responses
#### Success Response (200)
- **ContentPackages** (object) - Successful response containing package dependencies.

#### Success Response (204)
Successful response with no content.

#### Error Response (400)
- **APIError** (object) - The requested operation is invalid.

#### Error Response (401)
- **APIError** (object) - The requested operation requires authentication.

#### Error Response (404)
- **APIError** (object) - The requested object does not exist.

#### Error Response (500)
- **APIError** (object) - A server error occurred.
```

--------------------------------

### Deploy Example FastAPI App

Source: https://docs.posit.co/connect/user/fastapi

Deploy the example FastAPI application using rsconnect-python, specifying the entrypoint.

```bash
rsconnect deploy fastapi \
    -n <saved server name> \
    --entrypoint app:app \
    ./
```

--------------------------------

### Setup: Load Libraries and Define Inputs

Source: https://docs.posit.co/connect/cookbook/metrics/analyzing-usage-statistics-for-a-content-item

Loads necessary R libraries and defines user-configurable inputs for the analysis, such as content GUID, date range, and the number of top users to display. Ensure CONNECT_SERVER and CONNECT_API_KEY environment variables are set.

```r
#| label: setup
#| include: false

library(connectapi)
library(tidyverse)
library(gt)
library(plotly)

```

```r
#| label: user-defined inputs
#| include: false

# 1. specify the guid for the content
content_guid <- "INSERT_CONTENT_GUID"

# 2. Specify timeframe for the report. Default is 30 days prior to today
as_of_date <- lubridate::today()
days_back <- 30

# 3. Specify if the summary should show only the Top N users for the content (e.g., `top_n = 10`). Default is `Inf` so that all users are shown.
top_n <- Inf

# Note: The CONNECT_SERVER and CONNECT_API_KEY environment variables are required for this report to pull usage data. Use environment variables for added security; do not hard-code your API key or other secrets.

```

```r
#| label: report timeframe
#| include: false

report_from <- as_of_date - lubridate::ddays(days_back)

```

--------------------------------

### Displaying Usage Data Tibble

Source: https://docs.posit.co/connect/cookbook/metrics/analyzing-usage-statistics-for-a-content-item

Prints the resulting usage data tibble, showing content GUID, user GUID, start and end times, data version, and the day of usage.

```R
> usage
# A tibble: 14 × 6
   content_guid      user_guid         started             ended               data_version day
   <chr>             <chr>             <dttm>              <dttm>                     <int> <dttm>
 1 0477855b-caeb-... 1ec56831-7a34-... 2024-03-19 21:09:03 2024-03-19 21:10:05            1 2024-03-19 00:00:00
 2 0477855b-caeb-... 1ec56831-7a34-... 2024-03-19 21:39:07 2024-03-19 22:39:48            1 2024-03-19 00:00:00
 3 0477855b-caeb-... d59e7a7b-9684-... 2024-03-20 00:36:29 2024-03-20 00:37:10            1 2024-03-20 00:00:00
 4 0477855b-caeb-... 1ec56831-7a34-... 2024-03-20 13:50:55 2024-03-20 14:04:04            1 2024-03-20 00:00:00
 5 0477855b-caeb-... 1ec56831-7a34-... 2024-03-20 16:43:56 2024-03-20 16:44:12            1 2024-03-20 00:00:00
 6 0477855b-caeb-... d59e7a7b-9684-... 2024-03-21 10:52:14 2024-03-21 11:52:37            1 2024-03-21 00:00:00
 7 0477855b-caeb-... fc80bd89-4488-... 2024-03-25 19:16:45 2024-03-25 19:28:19            1 2024-03-25 00:00:00
 8 0477855b-caeb-... 989001e2-66df-... 2024-03-26 19:48:37 2024-03-26 21:43:10            1 2024-03-26 00:00:00
 9 0477855b-caeb-... 5c7cb633-5959-... 2024-03-28 17:13:03 2024-03-28 17:19:35            1 2024-03-28 00:00:00
10 0477855b-caeb-... fc80bd89-4488-... 2024-03-28 18:26:20 2024-03-28 18:34:40            1 2024-03-28 00:00:00
11 0477855b-caeb-... fc80bd89-4488-... 2024-03-28 20:53:50 2024-03-28 20:54:36            1 2024-03-28 00:00:00
12 0477855b-caeb-... cbee884e-f940-... 2024-03-29 16:13:44 2024-03-29 16:14:15            1 2024-03-29 00:00:00
13 0477855b-caeb-... fc80bd89-4488-... 2024-03-29 18:16:10 2024-03-29 20:43:52            1 2024-03-29 00:00:00
14 0477855b-caeb-... 3dc75833-f6c2-... 2024-04-11 00:36:00 2024-04-11 00:36:59            1 2024-04-11 00:00:00
```

--------------------------------

### Get All User Details

Source: https://docs.posit.co/connect/cookbook/metrics/analyzing-most-active-content-users-and-publishers

Fetches details for all users on the Posit Connect server, including their GUID, username, and email. This data is used to cross-reference user GUIDs with usernames for reporting purposes.

```r
all_users <- connectapi::get_users(client, limit = Inf) |
  select(guid, username, email) |> rename(user_guid = guid)
```

--------------------------------

### Initialize Posit Connect Client with Environment Variables (R)

Source: https://docs.posit.co/connect/cookbook/getting-started/initializing-a-client

Load the 'connectapi' library and create a client instance. The client automatically reads credentials from environment variables.

```r
library(connectapi)

client <- connect()
```

--------------------------------

### Get Git repository

Source: https://docs.posit.co/connect/api

Retrieves the Git repository location associated with a given content GUID.

```APIDOC
## GET /v1/content/{guid}/repository

### Description
Get the Git repository location associated with this content.

### Method
GET

### Endpoint
/v1/content/{guid}/repository

### Parameters
#### Path Parameters
- **guid** (string (uuid)) - Required - The unique identifier for the content.
```

--------------------------------

### Install Posit Connect with Helm

Source: https://docs.posit.co/connect/admin/getting-started/off-host-install/kubernetes-deployment

Use this command to perform an initial installation of Posit Connect using Helm. To update an existing installation with changes from your values file, run this command again.

```bash
helm upgrade --install rstudio-connect-prod rstudio/rstudio-connect \
    --values values.yaml
```

--------------------------------

### Preview a Quarto Project

Source: https://docs.posit.co/connect/user/scripts

Run `quarto preview` in the project directory to render and open the entire project in a browser. Changes are reflected automatically.

```bash
quarto preview
```

--------------------------------

### Get Vanity URL

Source: https://docs.posit.co/connect/api/openapi.yaml

Retrieves the vanity URL for a given content item identified by its GUID.

```APIDOC
## GET /content/{guid}/vanity

### Description
Retrieves the vanity URL for a specific content item.

### Method
GET

### Endpoint
/content/{guid}/vanity

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the content item.

### Response
#### Success Response (200)
- **url** (string) - The vanity URL associated with the content item.

#### Response Example
{
  "url": "/custom/path/to/content"
}
```

--------------------------------

### Get API Key

Source: https://docs.posit.co/connect/api/openapi.yaml

Retrieves details for a specific API key using its GUID and ID.

```APIDOC
## GET /v1/api_keys/{guid}/{id}

### Description
Get details for a single API key.

### Method
GET

### Endpoint
/v1/api_keys/{guid}/{id}

### Parameters
#### Path Parameters
- **guid** (string) - Required - The GUID of the API key.
- **id** (string) - Required - The ID of the API key.

### Response
#### Success Response (200)
- **APIKey** - Successful response.
```

--------------------------------

### Deploy Panel App to Connect

Source: https://docs.posit.co/connect/user/panel

After running the app locally, use this command to deploy it to Connect. The `.` indicates the current directory as the source for deployment.

```bash
rsconnect deploy panel -n <saved server name> --entrypoint app.py .
```

--------------------------------

### Revoke Group Access to Content using GUID

Source: https://docs.posit.co/connect/cookbook/content-access-controls/revoking-access-from-a-group

Use this method to remove a group's access to a content item by providing their respective GUIDs. Ensure you have the `posit` library installed and a client initialized.

```python
from posit import connect

CONTENT_GUID = "c92da1ad-9c48-420f-8e2a-dcd2d58f9723"
GROUP_GUID = "286d77ab-cc4d-430d-848d-67c8179de942"

client = connect.Client()

# Remove a single permission using a GUID
client.content.get(CONTENT_GUID).permissions.destroy(GROUP_GUID)
```

--------------------------------

### Activate License File (Root User)

Source: https://docs.posit.co/connect/admin/licensing

Activate a license file by copying it to the Posit Connect directory and restarting the service. This example assumes activation as the root user.

```bash
sudo chown root <license-file>.lic
sudo chmod 0600 <license-file>.lic
sudo cp -a <license-file.lic> /var/lib/rstudio-connect/
sudo systemctl restart rstudio-connect
```

--------------------------------

### Get Permission

Source: https://docs.posit.co/connect/api

Retrieves a specific permission entry for a content item using its GUID and the permission ID.

```APIDOC
## GET /v1/content/{guid}/permissions/{id}

### Description
Get a single permission entry for the content item, given its ID.

### Method
GET

### Endpoint
/v1/content/{guid}/permissions/{id}

### Parameters
#### Path Parameters
- **guid** (string (uuid)) - Required - The identifier of the content item.
- **id** (string) - Required - The identifier for this permission entry.

### Response
#### Success Response (200)
- **id** (string) - The identifier for this permission entry. Example: `101`.
- **content_guid** (string (uuid)) - The identifier of the content item. Example: `25438b83-ea6d-4839-ae8e-53c52ac5f9ce`.
- **principal_guid** (string (uuid)) - The identifier of the principal (user or group) listed in the ACL. Example: `62543474-5716-4423-92d1-b3a22163eb49`.
- **principal_type** (string) - The type of principal. Example: `user`.
- **role** (string) - The level of access that the principal has been given to this content item. Example: `viewer`.

#### Success Response (201)
- **id** (string) - The identifier for this permission entry. Example: `101`.
- **content_guid** (string (uuid)) - The identifier of the content item. Example: `25438b83-ea6d-4839-ae8e-53c52ac5f9ce`.
- **principal_guid** (string (uuid)) - The identifier of the principal (user or group) listed in the ACL. Example: `62543474-5716-4423-92d1-b3a22163eb49`.
- **principal_type** (string) - The type of principal. Example: `user`.
- **role** (string) - The level of access that the principal has been given to this content item. Example: `viewer`.

#### Error Response (400)
- **code** (integer) - The specific code for the type of error returned. See the API error codes reference for the full set of values. Required.
- **error** (string) - A description of the problem that was encountered. Required.
- **payload** (object|null) - Additional error details, if any. The structure varies by error type.

#### Error Response (401)
- **code** (integer) - The specific code for the type of error returned. See the API error codes reference for the full set of values. Required.
- **error** (string) - A description of the problem that was encountered. Required.
- **payload** (object|null) - Additional error details, if any. The structure varies by error type.

#### Error Response (403)
- **code** (integer) - The specific code for the type of error returned. See the API error codes reference for the full set of values. Required.
- **error** (string) - A description of the problem that was encountered. Required.
- **payload** (object|null) - Additional error details, if any. The structure varies by error type.

#### Error Response (404)
- **code** (integer) - The specific code for the type of error returned. See the API error codes reference for the full set of values. Required.
- **error** (string) - A description of the problem that was encountered. Required.
- **payload** (object|null) - Additional error details, if any. The structure varies by error type.

#### Error Response (500)
- **code** (integer) - The specific code for the type of error returned. See the API error codes reference for the full set of values. Required.
- **error** (string) - A description of the problem that was encountered. Required.
- **payload** (object|null) - Additional error details, if any. The structure varies by error type.
```

--------------------------------

### Deploy API with custom entrypoint

Source: https://docs.posit.co/connect/user/publishing-cli-apps

Use this command to deploy an API application when your application object is not a default one or is in a different file. Replace `example:myapp` with your file and object name.

```bash
rsconnect deploy api \
    -n <saved server name> \
    --entrypoint example:myapp ...
```
Tokens:
Raw