Posit Bundles API
The Bundles API from Posit — 5 operation(s) for bundles.
OpenAPI Specification
openapi: 3.0.3
info:
contact:
email: support@posit.co
name: Posit Connect Support
url: https://support.posit.co/hc/en-us
description: "## Overview\n\nThe Posit Connect Server API can be used to perform certain\nuser actions remotely. You will need to install a tool or library\nthat can make HTTP requests. We recommend using one of our SDKs, which\nare designed to make it easier to interact with the API.\n\n- Python: [posit-sdk](https://github.com/posit-dev/posit-sdk-py/)\n- R: [connectapi](https://posit-dev.github.io/connectapi/)\n\nThe SDKs are designed to work with the following values set in environment\nvariables, though you may provide them directly to the SDK if you prefer:\n\n- `CONNECT_SERVER` - The URL of the Posit Connect server.\n- `CONNECT_API_KEY` - Your API key.\n\nPlease note that all API paths are relative to the base API URL\n(e.g., `https://connect.example.com/__api__`).\nUnless otherwise noted, all endpoints which accept a request body\nwill require the body to be in JSON format.\nSimilarly, all response bodies will be returned in JSON format.\n\n### Specifications {#download}\n\nThe Posit Connect Server API OpenAPI specification is available for\ndownload as either JSON or YAML. Both formats contain the same\ninformation, also presented on this page.\n\n* <a href=\"openapi.json\" title=\"OpenAPI (JSON)\" target=\"_blank\">OpenAPI (JSON)</a>\n* <a href=\"openapi.yaml\" title=\"OpenAPI (YAML)\" target=\"_blank\">OpenAPI (YAML)</a>\n\n### Versioning of the API {#versioning-policy}\n\nThe Posit Connect Server API uses a simple, single number versioning scheme as noted\nas the first part of each endpoint path. This version number will only be incremented\nin the event that non-backward compatible changes are made to an existing endpoint.\nNote that this occurs on a per-endpoint basis; see the section on\n[deprecation](#deprecation) below for more information.\n\nChanges that are considered backward compatible are:\n\n* New fields in responses.\n* New non-required fields in requests.\n* New endpoint behavior which does not violate the current functional intent of the\n endpoint.\n\nChanges that are considered non-backward compatible are:\n\n* Removal or rename of request or response fields.\n* A change of the type or format of one or more request or response fields.\n* Addition of new required request fields.\n* A substantial deviation from the current functional intent of the endpoint.\n\nThe points relating to functional intent are assumed to be extremely rare as more\noften such situations will result in a completely new endpoint, which makes the\nchange a backward compatible addition.\n\n#### Experimentation\n\nPosit Connect labels experimental endpoints in the API by including `/experimental`\nin the endpoint path immediately after the version indicator. If an endpoint is noted\nas experimental, it should not be relied upon for any production work. These are\nendpoints that Posit Connect is making available to our customers to solicit\nfeedback; they are subject to change without notice. Such changes include anything\nfrom altered request/response shapes, to complete abandonment of the endpoint.\n\nThis public review of an experimental endpoint will last as long as necessary to either\nprove its viability or to determine that it's not really needed. The time for this\nwill vary based on the intricacies of each endpoint. When the endpoint is finalized,\nthe next release of Posit Connect will mark the experimental path as deprecated while\nadding the endpoint without the `/experimental` prefix. The path with the experimental\nprefix will be removed six months later. The documentation for the endpoint will also\nnote, during that time, the original, experimental, path.\n\nAll experimental endpoints are clearly marked as such in this documentation.\n\n#### Deprecation and removal of old versions {#deprecation}\n\nIt is possible that Posit Connect may decide to deprecate an endpoint. This will\nhappen if either the endpoint serves no useful purpose because its functionality is\nnow handled by a different endpoint or because there is a newer version of the endpoint\nthat should be used.\n\nIf a deprecated endpoint is called, the response to it will include an extra HTTP\nheader called, `X-Deprecated-Endpoint` and will have as a value the path of the\nendpoint that should be used instead. If the functionality has no direct replacement,\nthe value will be set to `n/a`.\n\nDeprecated versions of an endpoint will be supported for 1 year from the release date\nof Posit Connect in which the endpoint was marked as deprecated. At that time, the\nendpoint is subject to removal at the discretion of Posit Connect. The life cycle\nof an endpoint will follow these steps.\n\n1. The `/v1/endpoint` is public and in use by Posit Connect customers.\n1. Posit Connect makes `/v2/experimental/endpoint` available for testing and feedback.\n Customers should still use `/v1/endpoint` for production work.\n1. Posit Connect moves version 2 of the endpoint out of experimentation so, all within\n the same release:\n 1. `/v1/endpoint` is marked as deprecated.\n 1. `/v2/experimental/endpoint` is marked as deprecated.\n 1. `/v2/endpoint` is made public.\n1. Six months later, `/v2/experimental/endpoint` is removed from the product.\n1. Twelve months later, `/v1/endpoint` is removed from the product.\n\nNote that it is possible that Posit Connect may produce a new version of an existing\nendpoint without making an experimental version of it first. The same life cycle,\nwithout those parts, will still be followed.\n\n### Authentication {#authentication}\n\nAPI endpoints require you to identify yourself as a valid Posit Connect\nuser. You do this by specifying an API key when you make a call to the\nserver. The [API Keys](../user/api-keys/) chapter of the Posit Connect\nUser Guide explains how to create an API key.\n\n#### API Keys {#api-keys}\n\nAPI keys are managed by each user in the Posit Connect\ndashboard. If you ever lose an API key or otherwise feel it has\nbeen compromised, use the dashboard to revoke the key and create\nanother one.\n\n**WARNING**: Keep your API key safe. If your Posit Connect server's URL does not begin\nwith `https`, your API key could be intercepted and used by a malicious actor.\n\nOnce you have an API key, you can authenticate by passing the key with a prefix\nof `\"Key \"` (the space is important) in the Authorization header.\n\nBelow are examples of invoking the \"Get R Information\" endpoint.\n\n##### cURL\n\n```bash\ncurl -H \"Authorization: Key XXXXXXXXXXX\" \\\n https://positconnect.example.com/__api__/v1/server_settings/r\n```\n\n##### R\n\n```r\nlibrary(httr)\napiKey <- \"XXXXXXXXXXX\"\nresult <- GET(\"https://positconnect.example.com/__api__/v1/server_settings/r\",\n add_headers(Authorization = paste(\"Key\", apiKey)))\n```\n\n##### Python\n\n```python\nimport requests\nr = requests.get(\n 'https://positconnect.example.com/__api__/v1/server_settings/r',\n headers = { 'Authorization': 'Key XXXXXXXXXXX' }\n)\n```\n\n### API CORS considerations {#api-cors-considerations}\n\nFor information about using Connect's API from web applications in different domains,\nsee the [Cross-Origin Resource Sharing (CORS)](../admin/security/index.md#cors) section in\nthe security documentation.\n\n### Request correlation {#request-correlation}\n\nPosit Connect assigns a correlation ID to every API request via the\n`X-Correlation-ID` HTTP header. Connect includes this identifier in the response\nheaders and in server-side log entries, making it possible to trace a specific\nrequest through the system.\n\nIf you include an `X-Correlation-ID` header in your request, Connect preserves that\nvalue. If you do not include the header, Connect generates a Universally Unique\nIdentifier (UUID) automatically. Either way, the same value is returned in the\nresponse header.\n\nThis header is useful for:\n\n- **Debugging failed requests**: provide the correlation ID to your administrator so\n they can locate the corresponding server-side log entries.\n- **Correlating client-side and server-side activity**: set a known correlation ID in\n your client and match it against server logs or OpenTelemetry traces.\n\n**Example**\n\n```bash\n# Let Connect generate a correlation ID\ncurl -H \"Authorization: Key XXXXXXXXXXX\" -i \\\n https://positconnect.example.com/__api__/v1/user\n# Response includes: X-Correlation-ID: <generated-uuid>\n\n# Provide your own correlation ID\ncurl -H \"Authorization: Key XXXXXXXXXXX\" \\\n -H \"X-Correlation-ID: my-request-123\" -i \\\n https://positconnect.example.com/__api__/v1/user\n# Response includes: X-Correlation-ID: my-request-123\n```\n\n### API error codes {#api-error-codes}\n\n{{< include src/api_codes.fragment.html >}}\n"
license:
name: Commercial. Copyright 2015-2026 Posit Software, PBC. All Rights Reserved.
url: https://posit.co/about/eula/
termsOfService: https://posit.co/about/eula/
title: Posit Connect API Reference API Keys Bundles API
version: 1.0.1
servers:
- url: /__api__
security:
- apiKey: []
tags:
- name: Bundles
paths:
/v1/content/{guid}/bundles:
get:
description: 'List bundles associated with a specific content item.
Bundle enumeration is permitted by all users with viewership rights to
the content item and administrators. Information about the target
environment is populated for users with "publisher" and "administrator" role.
Results are sorted by ID in descending order (newest first).
This endpoint supports `page_number` and `page_size` query
parameters to limit the number of results returned.'
operationId: getBundles
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- description: The page number to return.
in: query
name: page_number
schema:
default: 1
format: int32
type: integer
- description: The number of items per page.
in: query
name: page_size
schema:
default: 20
format: int32
type: integer
- description: Whether results are in ascending order.
in: query
name: asc_order
schema:
default: true
type: boolean
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Bundle'
type: array
description: Successful response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation is invalid.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: You do not have permission to perform this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: List bundles
tags:
- Bundles
post:
description: "Create a new deployment bundle by uploading an archive.\n\nUpload a compressed `tar` archive containing code/data that represent\none deployment of this content. Bundles must be `gzip` compressed\n`tar` archives.\n\n* All deployment bundles include a `manifest.json` describing the\ncontained files and their runtime dependencies.\n* A bundle for a Shiny application includes an `app.R` or `ui.R`\nand `server.R`, and any images or data files required by the\napplication.\n* Python API and application bundles include the application source code,\ntypically named `app.py`, and a list of required package dependencies\nin `requirements.txt`.\n* An R Markdown document bundle includes the `index.Rmd` file along with\nany R scripts and data files needed to render the report.\n* A Quarto bundle includes at least one `.qmd` file, along with any\nauxiliary files required. Quarto projects include a `_quarto.yml` file.\n* Bundles containing HTML content should include any CSS, Javascript, and\nimages required by that document.\n\nThe `manifest.json` file and primary source files like `app.R`, `app.py`, or `index.Rmd`\nmust be in the top level of the archived directory. Subdirectories may be used\nfor secondary data and scripts.\n\nHere is how you might use `tar` to create an archive for a Shiny\napplication. It includes the manifest, the application, and an image.\n\n```bash\ntar zcf bundle.tar.gz ./manifest.json ./app.R ./www/logo.png\n```\n\nYou could create a bundle for a Python application similarly:\n\n```bash\ntar zcf bundle.tar.gz ./manifest.json ./app.py ./requirements.txt ./www/logo.png\n```\n\nHere is another example of creating a bundle for an application\nbut from its parent directory. The application is in a\n`sales-analyzer` sub-directory. This command will include all files\nin the subdirectory; check to ensure that this does not include\nextraneous files such as output files or local Python environments\nthat you do not want in the bundle.\n\n```bash\ntar zcf bundle.tar.gz ./sales-analyzer\n```\n\nPublishers with collaborator rights to this content (including the\nowner) are permitted to upload deployment bundles. Users without these\nrights are rejected.\n\nAdministrators must be a collaborator for a content item before they\nreceive upload rights.\n\n#### Upload formats\n\nThis endpoint supports two upload methods.\n\nYou can send the bundle archive directly as the request body with\n`Content-Type: application/gzip` or `application/x-gzip`:\n\n```bash\ncurl -X POST \\\n -H \"Authorization: Key ${API_KEY}\" \\\n -H \"Content-Type: application/gzip\" \\\n --data-binary @bundle.tar.gz \\\n \"https://connect.example.com/__api__/v1/content/${GUID}/bundles\"\n```\n\nOr, you can send the bundle as a multipart form and include a JSON object of metadata.\nThis allows you to include source control information and other arbitrary fields.\n\n```bash\ncurl -X POST \\\n -H \"Authorization: Key ${API_KEY}\" \\\n -F \"archive=@bundle.tar.gz\" \\\n -F 'metadata={\"source\":\"git\",\"source_repo\":\"https://github.com/org/repo\",\"source_branch\":\"main\",\"source_commit\":\"abc123\"};type=application/json' \\\n \"https://connect.example.com/__api__/v1/content/${GUID}/bundles\"\n```\n\nYou can also use multipart form to provide a URL to fetch the bundle from, along with metadata:\n\n```bash\ncurl -X POST \\\n -H \"Authorization: Key ${API_KEY}\" \\\n -F \"url=https://content-library.com/bundles/bundle.tar.gz\" \\\n -F 'metadata={\"source\":\"git\",\"source_repo\":\"https://github.com/org/repo\",\"source_branch\":\"main\",\"source_commit\":\"abc123\"};type=application/json' \\\n \"https://connect.example.com/__api__/v1/content/${GUID}/bundles\"\n```\n\nThe `metadata` form field is optional and accepts a JSON object string.\nSome fields are known to Connect and used in the application:\n\n* `source` - Source system identifier (e.g., \"git\", \"github-actions\", \"gitlab-ci\")\n* `source_repo` - Repository URL\n* `source_branch` - Branch or reference name\n* `source_commit` - Commit hash or identifier\n\nAdditional custom fields are accepted.\nField values are stored as strings; non-string values will be serialized\nto JSON.\n\n#### Code samples\n\n::: {.panel-tabset}\n\n##### curl\n\n###### Binary upload\n\n```bash\nAPI_KEY=\"your api key\"\nFILENAME=\"archive.tar.gz\"\n\ncurl --silent --show-error -L --max-redirs 0 --fail \\\n -X POST \\\n -H \"Authorization: Key ${API_KEY}\" \\\n -H \"Content-Type: application/gzip\" \\\n --data-binary @\"${FILENAME}\" \\\n \"https://connect.example.com/__api__/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\"\n```\n\n###### Multipart upload with metadata\n\n```bash\nAPI_KEY=\"your api key\"\nFILENAME=\"archive.tar.gz\"\n\ncurl --silent --show-error -L --max-redirs 0 --fail \\\n -X POST \\\n -H \"Authorization: Key ${API_KEY}\" \\\n -F 'metadata={\"source\":\"git\",\"source_repo\":\"https://github.com/org/repo\",\"source_branch\":\"main\",\"source_commit\":\"abc123def456\"};type=application/json' \\\n -F \"archive=@${FILENAME}\" \\\n \"https://connect.example.com/__api__/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\"\n```\n\n###### Multipart upload with URL and metadata\n\n```bash\nAPI_KEY=\"your api key\"\n\ncurl --silent --show-error -L --max-redirs 0 --fail \\\n -X POST \\\n -H \"Authorization: Key ${API_KEY}\" \\\n -F \"url=https://content-library.com/bundles/bundle.tar.gz\" \\\n -F 'metadata={\"source\":\"git\",\"source_repo\":\"https://github.com/org/repo\",\"source_branch\":\"main\",\"source_commit\":\"abc123def456\"};type=application/json' \\\n \"https://connect.example.com/__api__/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\"\n```\n\n##### Python\n\n###### Binary upload\n\n```python\nfrom posit import connect\n\n# Assumes CONNECT_SERVER and CONNECT_API_KEY are set in the environment\n\nclient = connect.Client()\nfilename = \"archive.tar.gz\"\n\nwith open(filename, \"rb\") as f:\n response = client.post(\"/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\",\n data=f)\n```\n\n###### Multipart upload with metadata\n\n```python\nimport requests\nimport json\n\n# Assumes CONNECT_SERVER and CONNECT_API_KEY are set in the environment\n\napi_key = \"your api key\"\nfilename = \"archive.tar.gz\"\n\nmetadata = {\n \"source\": \"git\",\n \"source_repo\": \"https://github.com/org/repo\",\n \"source_branch\": \"main\",\n \"source_commit\": \"abc123def456\"\n}\n\nwith open(filename, \"rb\") as f:\n # Fields can be provided in any order\n files = [\n (\"metadata\", (None, json.dumps(metadata), \"application/json\")),\n (\"archive\", f)\n ]\n response = requests.post(\n \"https://connect.example.com/__api__/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\",\n headers={\"Authorization\": f\"Key {api_key}\"},\n files=files\n )\n```\n\n###### Multipart upload with URL and metadata\n\n```python\nimport requests\nimport json\n\n# Assumes CONNECT_SERVER and CONNECT_API_KEY are set in the environment\n\napi_key = \"your api key\"\n\nmetadata = {\n \"source\": \"git\",\n \"source_repo\": \"https://github.com/org/repo\",\n \"source_branch\": \"main\",\n \"source_commit\": \"abc123def456\"\n}\n\n# Fields can be provided in any order\nfiles = [\n (\"metadata\", (None, json.dumps(metadata), \"application/json\")),\n (\"url\", (None, \"https://content-library.com/bundles/bundle.tar.gz\", \"text/plain\"))\n]\nresponse = requests.post(\n \"https://connect.example.com/__api__/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\",\n headers={\"Authorization\": f\"Key {api_key}\"},\n files=files\n)\n```\n\n##### R\n\n###### Binary upload\n\n```r\nlibrary(connectapi)\n\n# Assumes CONNECT_SERVER and CONNECT_API_KEY are set in the environment\n\nclient <- connect()\nfilename <- \"archive.tar.gz\"\nresult <- client$POST(\"/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\",\n body = upload_file(filename))\n```\n\n###### Multipart upload with metadata\n\n```r\nlibrary(httr)\nlibrary(jsonlite)\n\n# Assumes CONNECT_SERVER and CONNECT_API_KEY are set in the environment\n\napi_key <- Sys.getenv(\"CONNECT_API_KEY\")\nserver <- Sys.getenv(\"CONNECT_SERVER\")\nfilename <- \"archive.tar.gz\"\n\nmetadata <- list(\n source = \"git\",\n source_repo = \"https://github.com/org/repo\",\n source_branch = \"main\",\n source_commit = \"abc123def456\"\n)\n\n# Fields can be provided in any order\nresult <- POST(\n paste0(server, \"/__api__/v1/content/25438b83-ea6d-4839-ae8e-53c52ac5f9ce/bundles\"),\n add_headers(Authorization = paste(\"Key\", api_key)),\n body = list(\n metadata = toJSON(metadata, auto_unbox = TRUE),\n archive = upload_file(filename)\n )\n)\n```\n\n:::"
operationId: uploadContentBundle
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- description: URL of a gzip compressed tar archive.
in: query
name: url
schema:
type: string
- description: The Base64-encoded MD5 sum of the archive file.
in: header
name: X-Content-Checksum
schema:
type: string
requestBody:
content:
application/gzip:
schema:
format: binary
type: string
application/x-gzip:
schema:
format: binary
type: string
multipart/form-data:
schema:
additionalProperties: false
properties:
archive:
description: A gzip compressed tar archive file.
format: binary
type: string
metadata:
description: Optional JSON object containing metadata about this bundle.
type: string
url:
description: URL of a gzip compressed tar archive. Either archive or url must be provided.
type: string
type: object
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Bundle'
description: Successful response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation is invalid.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Create a bundle by uploading an archive
tags:
- Bundles
/v1/content/{guid}/bundles/{id}:
delete:
description: 'Delete a specific bundle.
Bundle deletion is permitted by authorized clients with collaborator
rights and administrators.
On-disk data and database records are removed as a consequence of this
call. Deletion is not allowed while the bundle is still active.'
operationId: deleteBundle
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
'204':
description: Successful response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation is invalid.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: You do not have permission to perform this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Delete bundle
tags:
- Bundles
get:
description: 'Get detailed information about a specific bundle.
Bundle reads are permitted by all users with viewership rights to the
content item and administrators. Information about the target environment
is populated for users with "publisher" and "administrator" role.'
operationId: getBundle
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Bundle'
description: Successful response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation is invalid.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: You do not have permission to perform this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Get bundle details
tags:
- Bundles
/v1/content/{guid}/bundles/{id}/download:
get:
description: 'Download a deployment bundle.
Bundle download is permitted by authorized clients with collaborator
rights.
Download a `gzip` compressed `tar` archive (`.tar.gz`) containing the
code/data from one deployment of the associated content.
See the [POST /v1/content/{guid}/bundles](#uploadContentBundle) endpoint for details about
the construction of bundle archives.'
operationId: downloadBundle
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successful response.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation is invalid.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: You do not have permission to perform this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Download the bundle archive
tags:
- Bundles
/v1/content/{guid}/bundles/{id}/files:
get:
description: 'Returns a JSON object containing every file inside the
bundle''s gzipped tar archive. Symlinks, directories, and
other special tar entries are not listed. Listing bundle
files is permitted by authorized clients with
collaborator rights and administrators.'
operationId: listBundleFiles
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successful response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: You do not have permission to perform this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: List files in a bundle
tags:
- Bundles
/v1/content/{guid}/bundles/{id}/files/*path:
get:
description: 'Returns the UTF-8 contents of one file inside a deployed
bundle''s gzipped tar archive. Binary files and files
larger than the inline-preview cap are reported with
flags and a null content body. Reading bundle file
content is permitted by authorized clients with
collaborator rights and administrators.'
operationId: getBundleFileContent
parameters:
- in: path
name: guid
required: true
schema:
format: uuid
type: string
- in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successful response.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested operation requires authentication.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: You do not have permission to perform this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: The requested object does not exist.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: A server error occurred.
summary: Get the contents of a file in a bundle
tags:
- Bundles
components:
schemas:
Bundle:
additionalProperties: false
description: A deployment bundle associated with a content item.
properties:
id:
description: The identifier for this bundle.
example: '101'
type: string
content_guid:
description: The identifier of the owning content.
example: 25438b83-ea6d-4839-ae8e-53c52ac5f9ce
format: uuid
type: string
created_by:
description: The GUID of the user who created the bundle.
format: uuid
nullable: true
type: string
created_time:
description: The timestamp (RFC3339) of when this bundle was created.
example: '2006-01-02T15:04:05-07:00'
format: date-time
type: string
environment_guid:
descript
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posit/refs/heads/main/openapi/posit-bundles-api-openapi.yml