How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Posit Content API

The Content API from Posit — 14 operation(s) for content.

Posit Content API is one of 33 APIs that Posit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Content. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 24 operations across 14 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against a single base URL, /__api__.

24 operations 14 paths 31 schemas 3 DELETE9 GET3 PATCH5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://connect.example.com/__api__
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Posit Content API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — Prefix your API key with Key , e.g. Key ABC123.

Paths & Operations 24

Across 14 paths, the API surfaces 24 operations — 3 DELETE, 9 GET, 3 PATCH, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Content 24
GET
/v1/content
List content items
getContents 3 params → 200400401403404500
POST
/v1/content
Create content item
createContent body → 200400401403404500
DELETE
/v1/content/{guid}
Delete content
deleteContent 1 param → 204400401404500
GET
/v1/content/{guid}
Get content details
getContent 2 params → 200400401404500
PATCH
/v1/content/{guid}
Update content
updateContent 1 param body → 200400401403404500
POST
/v1/content/{guid}/access-test
Triggers a Public Access Content Verification test
testPublicAccess 1 param → 200400401403404500
POST
/v1/content/{guid}/build
Build deployment bundle
buildContentBundle 1 param body → 200400401404500
POST
/v1/content/{guid}/deploy
Deploy deployment bundle
deployContentBundle 1 param body → 202400401404500
GET
/v1/content/{guid}/environment
Get environment variables
getContentEnvironment 1 param → 200400401404500
PATCH
/v1/content/{guid}/environment
Update environment variables
updateContentEnvironment 1 param body → 200400401404500
PUT
/v1/content/{guid}/environment
Set all environment variables
setContentEnvironment 1 param body → 200400401404500
GET
/v1/content/{guid}/lockfile
Get Python lockfile
getContentLockfile 1 param → 200400401403404500
GET
/v1/content/{guid}/oauth/integrations/associations
List all OAuth integration associations for this content item
listContentOAuthIntegrationAssociations 1 param → 200400401404500
PUT
/v1/content/{guid}/oauth/integrations/associations
Set all OAuth integration associations
setOAuthIntegrationAssociations 1 param body → 204400401404500
GET
/v1/content/{guid}/packages
Get package dependencies
getContentPackages 1 param → 200204400401404500
POST
/v1/content/{guid}/render
Render content
renderContent 1 param body → 202400401403404500
DELETE
/v1/content/{guid}/repository
Remove Git repository location
deleteContentRepository 1 param → 204400401404500
GET
/v1/content/{guid}/repository
Get Git repository
getContentRepository 1 param → 200400401404500
PATCH
/v1/content/{guid}/repository
Update Git repository
updateContentRepository 1 param body → 200400401404409500
PUT
/v1/content/{guid}/repository
Set Git repository
setContentRepository 1 param body → 200400401404500
DELETE
/v1/content/{guid}/thumbnail
Delete a content thumbnail
deleteContentThumbnail 1 param → 204400401403404500
PUT
/v1/content/{guid}/thumbnail
Set a content thumbnail
setContentThumbnail 1 param body → 204400401403404500
GET
/v1/search/content
Search for content items
searchContent 6 params → 200400401403500
GET
/v1/search/variants
Search for variants
searchVariants 6 params → 200400401403500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Content (57 properties), UpdateContentInput (32 properties), CreateContentInput (28 properties), VariantSearchResult (13 properties). Each schema is shown below with its type and property counts.

UpdateContentInput
object
The content fields that can be specified when updating a content item.
32 properties
Schedule
object
Base schedule information for a content item.
8 properties
OffsetPaging
object
Offset-based pagination metadata.
2 properties
VariantResults
Search results containing variants and pagination metadata.
ContentRenderInstructions
object
Instructions for rendering a content item.
1 property
ScheduleVariant
object
Variant information embedded in a schedule.
3 properties
ScheduleLastRun
object
Information about the last scheduled run.
8 properties
CreateContentInput
object
The content fields that can be specified when creating a content item.
28 properties
ContentOwner
object
Basic details about the owner of a content item.
4 properties
VariantSearchResult
object
A single variant in search results.
13 properties
ContentResults
Search results containing content items and pagination metadata.
RRuleSet
object
RFC 5545 recurrence rule components for a schedule.
3 properties
ContentSchedule
Schedule information with variant details for a content item.
ContentDeploymentInstructions
object
Optionally identifies the target deployment bundle.
2 properties
Tag
object
A tag used to organize content within Connect.
5 properties
OAuthIntegrationAssociationInput
object
An OAuth integration GUID to associate with a content item.
1 property
ContentDeploymentTask
object
Identifies the task that can be used to track the progress of a deployment operation.
1 property
OAuthIntegrationAssociationOutput
object
Represents an association between a content item and an OAuth integration.
8 properties
EnvironmentVariable
object
Defines an environment variable and its value.
2 properties
ContentPackages
array
Lists the packages installed for a content item.
EnvironmentVariables
array
List of environment variables with their values.
EnvironmentVariableNames
array
List of environment variable names, without values.
GitLocationOutput
object
Git location associated with a content item.
7 properties
Package
object
A package dependency record.
10 properties
Content
object
The content object models all the "things" you may deploy to Posit Connect. This includes Shiny applications, R Markdown documents, Jupyter notebooks, Plumber…
57 properties
APIError
object
The error object returned by the API on failure.
3 properties 2 required
GitLocationInput
object
Git location associated with a content item.
4 properties
ContentBuildInstructions
object
Optionally identifies the target build bundle.
2 properties
ContentRenderTask
object
The result of requesting a content render, containing a task identifier.
1 property
AccessTestResult
object
The results of the public access content verification test.
5 properties
ContentBuildTask
object
Identifies the task that can be used to track the progress of a build operation.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posit-content-api-openapi.yml Raw ↑

Other APIs Posit publishes across the network.

Posit API Keys API
Posit Audit Logs API
Posit Bookmarks API
Posit Bootstrap API
Posit Bundles API
Posit Content Permissions API
Posit Custom Documentation API
Posit Environment Permissions API
Posit Environments API
Posit Examples API
Posit Feature Usage API
Posit Groups API
Where this information came from

This is an independent, third-party profile of Posit Content API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.